OpenFeign/feign

Update Java Doc

Open

#772 opened on Aug 16, 2018

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Java (1,911 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (9,070 stars)
PR merge metrics
 (Avg merge 2d 17h) (71 merged PRs in 30d)

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

Research direction
Review the current JavaDoc files in the repository, identify outdated or misleading content, and check the release process to see what documentation is missing. Then update the JavaDoc accordingly.
Tech stack
java
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80