Javadoc warnings are the only noise on an otherwise clean CI run
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 72/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- github-actions, java
- Lĩnh vực
- build-system, ci-cd, documentation
Hướng nghiên cứu
Bắt đầu từ các cảnh báo javadoc của CI (ví dụ Commutable.java quanh dòng 58: thiếu comment và @return) và ghi chú trong docs/landing-surface-checklist.md §3. Hoặc thêm javadoc còn thiếu trên một số ít public member đang cảnh báo, hoặc điều chỉnh javadoc task cho các module nội bộ trong build file kèm comment ngắn giải thích lý do. Không tắt javadoc trên toàn cục. Xong khi một lần chạy CI sạch không còn hiện những annotation đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
The build is green, but the run surfaces javadoc warnings as GitHub annotations — for example
Commutable.java#58: "no comment", "no @return". Harmless, but they are the only noise on the run,
which makes a real annotation easy to miss.
What to do: either write the missing javadoc on the handful of public members that warn, or
decide the project does not want javadoc enforcement on internal modules and configure the task
accordingly. Please do not silence it globally without saying why in the build file.
Recorded in docs/landing-surface-checklist.md §3.
- Ngôn ngữ chính
- Java
- Star
- 1
- Fork
- 1
- Merge trung bình
- 1 giờ 34 phút
- Pull request đã merge (30 ngày)
- 7
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của CodeLaser/maddi
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
CodeLaser/maddi#166 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Java printer: a class literal in an annotation value prints by simple name, without an importĐang mởbug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Java printer: a static interface method called from an implementing class prints unqualifiedĐang mởbug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 30/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 45/100
CodeLaser/maddi#165 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của CodeLaser/maddi
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 75/100
521xueweihan/HelloGitHub#4105 ·
-
Awaiting further input from submitter
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
Regression in 5.9.0: CuratorCache fails with ClassCastException when the client is not a CuratorFrameworkBaseCó thể đã có người làm @sftwnd đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
Maintainer thường phản hồi trong vòng 1 ngày