spring-cloud / spring-cloud/spring-cloud-gateway
Have documentation samples use includes from tests
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Java
- Stars
- 4.9k
- Forks
- 3.5k
- Avg merge
- 20h 57m
- Merged PRs (30d)
- 8
Description
This will prevent issues like #230 and also prevent the examples from being out of data.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading issue #230, then locate the documentation samples and the tests whose content they should include. Confirm the samples can source their examples from those tests and verify that the documentation no longer duplicates outdated example content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100