quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

Open

#6,983 opened on 2020年2月4日

GitHub で見る
 (8 comments) (0 reactions) (0 assignees)Java (2,464 forks)batch import
good first issuekind/enhancement

Repository metrics

Stars
 (12,967 stars)
PR merge metrics
 (平均マージ 6d 4h) (30d で 325 merged PRs)

説明

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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
JavaMaven or GradleAnnotation processing
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65