spring-projects / spring-projects/spring-batch
Code samples in documentation should be compiled and verified
Open
Nobody has claimed this yet.
in: documentation
type: enhancement
- Dominant language
- Java
- Stars
- 3k
- Forks
- 2.5k
- Avg merge
- 6d 53m
- Merged PRs (30d)
- 3
Description
Code examples in the documentation should be included from sources that are compiled and verified automatically. This will prevent typos and errors like #4199.
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
The issue names no specific documentation files, source locations, tests, or build entry points. Start by locating the documented code examples and the project’s existing build and verification workflow, then determine how examples can be compiled automatically. Done means documentation examples are sourced from verifiable code and the workflow catches errors such as typos before release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- ci-cd, documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100