Skip to content
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.

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

[Github] Security impact field in templates #14666

Merged
merged 4 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/change-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Change Request
description: Tracker issues for new features, enhancements, or configuration changes.
labels: needs-triage
body:
- type: textarea
id: description
attributes:
label: Description
description: What is the change?
validations:
required: true
- type: dropdown
id: security-impact
attributes:
label: Security Impact
description: Level of security impact of the change
options:
- None
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I try to preview this template, I get this error about None being a reserved keyword, since it is the default option when a dropdown field is not marked as required.

I think it would make the most sense to make this field required and change this option to be called No impact, so that when filling out the template, we have to explicitly make a choice about what level of impact it will have. However, if we'd prefer to keep it as an optional field, we can just remove this option, and None will still be present in the dropdown (and will be the default option).

- Low
- Medium
- High
- type: textarea
id: security-impact-description
attributes:
label: Security Impact Description
description: If the impact is not None, please describe the security impact and necessary mitigations
validations:
required: true
- type: checkboxes
id: appsec-signoff
attributes:
label: Appsec Signoff
description: If the security impact is High, has the change been reviewed and approved by the Appsec team?
options:
- label: Reviewed and approved
required: false
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Fixes #<issue_number>.

### Change Description

<!-- What is the purpose of this change? What should reviewers know? -->

### Security Impact

<!-- Please select one of the following -->

- [ ] The security impact will be assessed in this PR description
- [ ] The security impact is assessed in the linked issue

(Reviewers: please confirm the security impact before approving)

<!-- If the security impact is to be assessed in the PR:
#### Security Assessment

- [ ] This change has a high security impact
- [ ] The impact has been assessed and approved by appsec
- [ ] This change has a medium security impact
- [ ] This change has a low security impact
- [ ] This change has no security impact

Please describe the security impact and necessary mitigations here.
For none/low impact: a quick one/two sentence justification of the low rating is sufficient.
For medium/high impact: please provide a detailed description of the impact and the mitigations in place.
-->
Loading