spring-projects / spring-projects/spring-security
Add package javadoc to remaining packages
Open
Nobody has claimed this yet.
in: build
type: enhancement
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
spring-javaformat-checkstyle 0.032+ requires package javadoc which breaks the Spring Security Build. We need to fix the build to work with these changes and update the version. See gh-328
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 Spring Security build configuration and the spring-javaformat-checkstyle version, then identify the remaining packages without package Javadoc. Use gh-328 for the required formatter behavior; done means the build works with version 0.032+ and the formatter version is updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100