open-feature / open-feature/java-sdk
Audit usage of @inheritDoc
Đang mở
contribfest
good first issue
help wanted
- Ngôn ngữ chính
- Java
- Star
- 128
- Fork
- 61
- Merge trung bình
- 5 giờ 57 phút
- Pull request đã merge (30 ngày)
- 26
Mô tả
We're using `@inheritDoc` to avoid writing javadoc, but that's not well founded in some cases. Audit the usage of it and ensure our docs are reasonable.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng cách tìm kiếm trong repository mọi cách sử dụng @inheritDoc và xem xét Javadoc xung quanh để xác định liệu tài liệu được kế thừa có phù hợp hay không. Công việc được hoàn tất khi mỗi cách sử dụng đều có tài liệu hợp lý và có chủ đích, nhưng issue không nêu tên các tệp hoặc bài kiểm thử cụ thể.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- java
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100