spring-projects / spring-projects/spring-security
Documentation snippets should be includes
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
To ensure the code snippets in our docs remain up to date, they should use tested code. Two possible sources for tested code are snippets from tests and from samples.
In some cases, this will mean changing documentation snippets and surrounding text to use an existing test or sample. In other cases, it will mean adding a test or sample project.
Instead of copying code into a documentation snippet, it should use an include.
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 locating the documentation snippets and the existing tests or sample projects that could provide tested code. Review how documentation includes are currently used; done means replacing copied snippets with includes and adding tests or samples where no suitable source exists.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100