OpenFeign/feign

Update Java Doc

Open

#772 ouverte le 16 août 2018

Voir sur GitHub
 (0 commentaires) (1 réaction) (0 assignés)Java (9 070 stars) (1 911 forks)batch import
documentationhelp wanted

Description

The current set of Java Doc is old and in some cases, misleading. Also, during a release, there are a number of items missing.

Guide contributeur

Stack technique
java
Domaine
documentationapi
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.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
needs investigation
Prérequis
JavaJavaDoc knowledgefamiliarity with Feign
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
Start by identifying the current JavaDoc files in the repository. Compare with the actual behavior of the code, noting any outdated or misleading parts. Look at recent commits and release notes to see what features or changes are missing from the documentation. Consider adding missing JavaDoc for new classes or methods. The issue lacks specific examples, so you may need to scan the codebase and open a follow up issue if the scope is too broad.