spring-projects / spring-projects/spring-security
Provide a description for each package included in the javadoc
Open
Nobody has claimed this yet.
in: docs
type: enhancement
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
When browsing Spring Security's javadoc, a number of documented packages do not have a description. I think it would ease navigation if a description was provided for each documented package.
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 reviewing the packages included in Spring Security's generated Javadoc and identify which documented packages lack descriptions. Add a suitable description for every such package, then regenerate or inspect the Javadoc to confirm that each package is described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100