quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

Open

#6,983 建立於 2020年2月4日

在 GitHub 查看
 (8 留言) (0 反應) (0 負責人)Java (2,464 fork)batch import
good first issuekind/enhancement

倉庫指標

Star
 (12,967 star)
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