spring-projects / spring-projects/spring-security
Improve javadoc for User's withDefaultPasswordEncoder method to include Spring Boot CLI as an alternative too
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Currently For SS 6.1.1 the User class has the withDefaultPasswordEncoder deprecated method with its respective javadoc.
About the second part of this javadoc is indicated what is the correct approach to take, but I think is wise add as a complement a better alternative. Spring Boot CLI with the respective command execution spring encodepassword password as sample
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
Open core/src/main/java/org/springframework/security/core/userdetails/User.java and review the javadoc for the deprecated withDefaultPasswordEncoder method. Add the Spring Boot CLI alternative using the command shown in the issue, then verify that the documentation clearly presents it as an alternative approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100