OpenFeign/feign

Update Java Doc

Open

#772 geöffnet am 16. Aug. 2018

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Java (9.070 Stars) (1.911 Forks)batch import
documentationhelp wanted

Beschreibung

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

Contributor Guide

Tech Stack
java
Domain
documentationapi
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
needs investigation
Voraussetzungen
JavaJavaDoc knowledgefamiliarity with Feign
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.