quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

开放

#6,983 创建于 2020年2月4日

在 GitHub 查看贡献者指南
 (8 条评论) (0 个反应) (0 位负责人)Java (2,464 个派生)batch import
good first issuekind/enhancement

仓库指标

星标
 (12,967 个星标)
PR 合并指标
 (平均合并 6天 4小时) (30 天内合并 325 个 PR)

描述

A big value of extensions is the BuildItem model. We need to document them so other extension writers can discover and use them. They are also part of the extension contract.

  1. document all "public" BuildItem with adequate JavaDoc
  2. build an anotation processor that will collect the BuildItems and generate a list of them per extension and a documentation (summary?).

贡献者指南

研究方向
研究现有的BuildItem类及其JavaDoc，然后设计一个注解处理器来收集并为每个扩展生成BuildItem列表。考虑使用javax.annotation.processing包或类似工具。
技术栈
java
领域
backenddocumentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JavaMaven or GradleAnnotation processing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65