quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

Open

#6 983 ouverte le 4 févr. 2020

Voir sur GitHub
 (8 commentaires) (0 réactions) (0 assignés)Java (2 464 forks)batch import
good first issuekind/enhancement

Métriques du dépôt

Stars
 (12 967 stars)
Métriques de merge PR
 (Merge moyen 6j 4h) (325 PRs mergées en 30 j)

Description

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?).

Guide contributeur

Direction de recherche
Étudiez les classes BuildItem existantes et leur JavaDoc, puis concevez un processeur d'annotations pour collecter et générer une liste de BuildItems par extension. Envisagez d'utiliser le paquet javax.annotation.processing ou similaire.
Stack technique
java
Domaine
backenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaMaven or GradleAnnotation processing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65