OpenFeign/feign

Update Java Doc

Open

#772 opened on Aug 16, 2018

View on GitHub
 (0 comments) (1 reaction) (0 assignees)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.

Contributor guide

Tech stack
java
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
JavaJavaDoc knowledgefamiliarity with Feign
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.