spring-projects / spring-projects/spring-security
SEC-2008: Documentation does not explain any of Events published by spring security on the Spring Context
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Adib Saikali (Migrated from SEC-2008) said:
The documentation for spring security makes no mention of how to react to events in the spring security life cycle. Common things like how do I run some code if a login is successful, when a logout occurs ... etc
Without reading the source code it is not possible to understand how easy it is to do some of these things using the events by Spring Security on the SecurityContext.
It is simply too hard to figure out how to do these common operations without the docs at least mentioning how this can be done.
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 Spring Security documentation and the code that publishes events on the Spring Context. Review the login and logout lifecycle events named in the issue, then document how applications can react to them. Done when these common operations are explained without requiring source-code reading.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100