chore: updated defaults.go references in documentation for adding new detectors #4344
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
ahrav
approved these changes
Jul 26, 2025
There was a problem hiding this comment.
Thank you for updating this @Jeff-Rowell , we really appreciate it.
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.
Description:
The documentation for adding a new secret detector was not updated after this change moving pkg/engine/defaults.go to pkg/engine/defaults/defaults.go:
The documentation should maintain accuracy as new contributors are expected to read the documentation for adding new detectors. The previous references to the
pkg/engine/defaults.gofile directed to a 404 not found page. This can lead to confusion if/when new contributors are reading the hack documentation for adding a new detector.