Skip to content

Clarify Autofix deviation approval metadata #1193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mbaluda wants to merge 1 commit into from
Closed

Clarify Autofix deviation approval metadata #1193

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/autofix-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,9 @@ When an alert is judged to be a false positive, the autofix PR must:
(what the query missed, why the code is in fact compliant or safe);
- `scope`, `background`, and `requirements` when they help a reviewer
audit the decision;
- a `raised-by` entry (and leave `approved-by` for a human reviewer).
- omit both `raised-by` and `approved-by` from the initial fix because the
deviation format requires them to be specified together. A human reviewer
may add both entries when approving the deviation.
4. **Place the deviation entry** of types 2. and 3. in an existing
`coding-standards.yml` if one exists in an appropriate directory;
otherwise create one at the most specific directory whose subtree is
Expand Down