docs: describe extended rules take precedence over base rules #1563
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rgmz
reviewed
Oct 14, 2024
README.md
Outdated
| # the base rules take precedence over the extended rules. I.e., if there are | ||
| # duplicate rules in both the base configuration and the extended configuration | ||
| # the base rules will override the extended rules. | ||
| # the extended rules take precedence over the base rules. I.e., if there are |
There was a problem hiding this comment.
There was a problem hiding this comment.
Yes, you are right. I somehow struggle a bit to suggest a proper text here. @rgmz Do you have a good suggestion?
There was a problem hiding this comment.
- "custom" would be a better word for the user-defined config. "base" can cause confusion, as it maybe misunderstood to refer the default config (gitleaks provided).
- Users would generally want "custom" user-defined config rules to take precedence (override) over the "inherited" rules from the extended / parent / default config.
- If there are exceptions on this overriding, it maybe noted.
I hope that these word suggestions help to form a better text here. Let me know if I can help.
There was a problem hiding this comment.
@zricethezav @rgmz @amithm7 I rewrote the README.md regarding extending rules, please take a look.
06edd8a to
f4b58c0
Compare
f4b58c0 to
a84489b
Compare
|
@rgmz @zricethezav please close this PR if you see no value. |
|
That's up to @zricethezav: I have no permissions. Personally, I think it's a good change. |
|
fell off the radar, sorry about that. Thanks @bufferoverflow and @rgmz |
alayne222
pushed a commit
to alayne222/gitleaks
that referenced
this pull request
May 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1384
Description:
Document actual behavior
Checklist: