Move some configuration into the docs themselves #655
Merged
Conversation
This file contains 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
For convenience and for more clarity to end users, having the configuration in the docs themselves can aid how each rule is configured. Later, when precli handles a configuration file mechanism, a user can customize rules based on this config noted in the docs in each rule. Signed-off-by: Eric Brown <eric.brown@securesauce.dev>
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.
For convenience and for more clarity to end users, having the configuration in the docs themselves can aid how each rule is configured.
Later, when precli handles a configuration file mechanism, a user can customize rules based on this config noted in the docs in each rule.