OpenFeign / OpenFeign/feign

Update Java Doc

Open
#772 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
Java
Stars
9.8k
Forks
1.9k
Avg merge
1d 2h
Merged PRs (30d)
41

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by auditing the current Java documentation and the items used during a release. Identify which content is outdated or misleading and which release items are missing. Done means the Java documentation is accurate and the release documentation covers the required items.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.