open-feature / open-feature/java-sdk
Audit usage of @inheritDoc
未关闭
contribfest
good first issue
help wanted
- 主要语言
- Java
- 星标
- 128
- 派生
- 61
- 平均合并
- 5 小时 57 分钟
- 30 天内合并 PR
- 26
描述
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.
贡献指南
调研方向
首先在仓库中搜索 @inheritDoc 的每一处使用，并检查周围的 Javadoc，以判断继承的文档是否合适。当每一处使用都有合理且有意编写的文档时，工作即告完成，但该 issue 未指定具体的文件或测试。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100