Rule validaton request template (github issue) #1903
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| name : Validation rule request | ||
| about : A detailed specification for a new SARIF validation rule to add to the Sarif.Multitool validate command. | ||
| title : "[RULE REQUEST] Concise description of new analysis" | ||
| labels : validation-rule-request | ||
| assignees : '' | ||
|
|
||
| --- | ||
|
|
||
| *********************************************************************************************************** | ||
|
|
||
| # Rule Proposal: [Friendly Rule Name] | ||
| - *Synopsis* : [Brief summary of the rule, include code snippets if possible.] | ||
|
|
||
| - *[Violation Example]* : [Optional, Include code snippet which should trigger the violation.] | ||
|
|
||
| - *[No Violation Example]* : [Optional, Include code snippet which demostrates ideal condition (no violation).] | ||
|
|
||
| *********************************************************************************************************** | ||
|
|
||
| ### Rule metadata | ||
| - [*Id*] : [Should be formatted as `SARIF1nnn`, leave blank if unsure] | ||
| - *Name* : [Provide a friendly symbolic name for the rule in PascalCase.] | ||
| - *Level* : [Possible values are: `error`, `warning`, or `note`.] | ||
| - *Short description* : [Short description of the rule.] | ||
| - *Full description* : [Full description, should describe usage of the rule and any other relevant information.] | ||
|
|
||
| - User-facing strings: | ||
| Each rule has one or more result message strings, each with symbolic name in PascalCase. | ||
|
There was a problem hiding this comment.
As authored, this will appear on the same line as "User-facing strings". Is that what you intended? If so, did you mean to enclose it in square brackets as you did for the other field descriptions? #Closed There was a problem hiding this comment. oh, yes - this is supposed to be an instruction! thanks, will fix. In reply to: 435556107 [](ancestors = 435556107) |
||
|
|
||
| - *FirstMessage* : [Default user facing string.] | ||
| - *[SecondMessage]* : [Optional, Any conditional user facing string(s).] | ||
| - *[ThirdMessage]* : [Optional, Any conditional user facing string(s).] | ||
|
|
||
| *********************************************************************************************************** | ||
|
|
||
| ### Links/Additional Information | ||
| *[Optional, any Links/Additional Information.]* | ||
|
|
||
| ### Implementation Notes | ||
| *[Optional, any suggestions regarding implementation.]* | ||
|
|
||
| ### How to resolve | ||
| *[Optional, any tips on how to resolve the violation.]* | ||
|
|
||
|
|
||
|
There was a problem hiding this comment. While you're at it, remove extra blank line. #Closed |
||
| *********************************************************************************************************** | ||
|
There was a problem hiding this comment. I would suggest to link a rule that we consider an example, or at least, write one as sample. |
||
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.
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.
No short description. Taken from the first sentence of the full description. #Closed
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.
ok. i will include this detail in the instruction so that the rule requester knows.
In reply to: 435554545 [](ancestors = 435554545)
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.
good idea.
In reply to: 435563131 [](ancestors = 435563131,435554545)