-
Notifications
You must be signed in to change notification settings - Fork 22
docs: add warnings and a use case on false positive management #247
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
thanks for your PR - please make a bit more informative comment under the PR. For example, please see this. The two relevant questions are "why" and "what", with one-one sentences. Thank you again. |
|
@airween done, does this sound good to you ? |
airween
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a native English speaker so it's not the best idea to give a review, but I made a suggestion.
Cc: @theseion, @RedXanadu.
Yes, excellent! Thank you! |
Co-authored-by: Ervin Hegedus <airween@gmail.com>
Co-authored-by: Max Leske <250711+theseion@users.noreply.github.com>
|
Please work through the open comments @touchweb-vincent. |
|
@theseion I was waiting for your point of view before committing the changes. The changes have now been committed. |
|
Please mark comments as resolved when you're done with them (two where still unresolved). That helps me, as a reviewer, to know that you've seen every comment. If you decide to not apply a suggestion or act on a comment (which is a valid choice), please provide a reason for why. Otherwise I have to assume you didn't read or understand the comment. |
|
Please resolve the open comments @touchweb-vincent. |
|
@theseion All comments have been marked as resolved here. |
Hello,
what
This PR adds explicit warning notices to several rule-exclusion examples and documentation sections.
These notices remind users that:
why
To help users avoid unsafe tuning practices that could compromise the effectiveness of CRS.
Some examples and documentation snippets may look harmless, but when reused without proper context they can lead to overly broad exclusions or rule bypasses.
Adding warnings provides clear guidance about when an example is for demonstration only, and when it should never be used in production.