spring-projects / spring-projects/spring-security
Add Code Style to Wiki
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Spring Framework's Code Style is well documented in their Wiki.
Currently, Spring Security's Code Style is partially documented in CONTRIBUTING and enforced by plugin's.
We should extract and consolidate all Code Style into a separate Wiki page and expand with more detail.
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 with CONTRIBUTING.md and compare its existing code-style guidance with the Spring Framework Code Style wiki page linked in the issue. Consolidate Spring Security's code-style information into a separate Wiki page, expanding the details; the work is done when the style guidance is documented there rather than only partially in CONTRIBUTING.md.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100