enhancement: add support for specifying coding standards filename and…#96
Merged
lcartey merged 7 commits intogithub:mainfrom Oct 21, 2022
intern4tional:enhancement/yaml
Merged
enhancement: add support for specifying coding standards filename and…#96lcartey merged 7 commits intogithub:mainfrom intern4tional:enhancement/yaml
lcartey merged 7 commits intogithub:mainfrom
intern4tional:enhancement/yaml
Conversation
lcartey
suggested changes
Oct 7, 2022
Contributor
lcartey
left a comment
There was a problem hiding this comment.
Thanks for opening this pull request!
I've made a recommendation to accept both .yml and .yaml by default. That would avoid the need to have an optional argument, unless you see a need to customize it beyond the extension.
Co-authored-by: Luke Cartey <5377966+lcartey@users.noreply.github.com>
lcartey
approved these changes
Oct 11, 2022
Contributor
lcartey
left a comment
There was a problem hiding this comment.
Looks good, thanks for the changes!
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
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
This pull request adds the --coding-standards-file option to the process_coding_standards_config.py script to allow for specifying an alternative filename and extension for your coding standards deviations file.
It addresses issue 95.
Change request type
Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.