coreruleset / coreruleset/documentation
Add documentation for the --enable-request-early compilation flag
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6
- Forks
- 23
- Avg merge
- 47m
- Merged PRs (30d)
- 1
Description
Motivation
In the monthly chat from May 5th 2025 we decided to document the --enable-request-early compilation flag.
This flag is disabled by default, but can cause problems if enabled as described in issue https://github.com/coreruleset/coreruleset/issues/3696. We think that documenting this flag is enough to address this problem in CRS.
Proposed solution
Document the --enable-request-early compilation flag in the CRS docs.
Additional context
https://github.com/owasp-modsecurity/ModSecurity/issues/3362
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 CRS documentation section covering ModSecurity compilation or configuration flags, then read the linked CRS and ModSecurity issues for the flag's behavior and risks. Document --enable-request-early, including that it is disabled by default and may cause problems when enabled; the documentation should clearly explain the relevant warning.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100