Skip to content

Commit 8b58978

Browse files
scubaninjascubaninja
committed
Add issue templates for bug reports, feature requests, security incidents, security requirements, and threat models
1 parent 95cf035 commit 8b58978

6 files changed

Lines changed: 579 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
projects: ["clever-org-name/2"]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
- type: input
13+
id: contact
14+
attributes:
15+
label: Contact Details
16+
description: How can we get in touch with you if we need more info?
17+
placeholder: ex. email@example.com
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: what-happened
22+
attributes:
23+
label: What happened?
24+
description: Also tell us, what did you expect to happen?
25+
placeholder: Tell us what you see!
26+
value: "A bug happened!"
27+
validations:
28+
required: true
29+
- type: dropdown
30+
id: version
31+
attributes:
32+
label: Version
33+
description: What version of our software are you running?
34+
options:
35+
- 1.0.2 (Default)
36+
- 1.0.3 (Edge)
37+
default: 0
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: browsers
42+
attributes:
43+
label: What browsers are you seeing the problem on?
44+
multiple: true
45+
options:
46+
- Firefox
47+
- Chrome
48+
- Safari
49+
- Microsoft Edge
50+
- type: textarea
51+
id: logs
52+
attributes:
53+
label: Relevant log output
54+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
55+
render: shell
56+
- type: checkboxes
57+
id: terms
58+
attributes:
59+
label: Code of Conduct
60+
description: By submitting this issue, you agree to follow our [Code of Conduct](#)
61+
options:
62+
- label: I agree to follow this project's Code of Conduct
63+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: GitHub Community Support
4+
url: https://github.com/orgs/community/discussions
5+
about: Please ask and answer questions here.
6+
- name: GitHub Security Bug Bounty
7+
url: https://bounty.github.com/
8+
about: Please report security vulnerabilities here.

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Feature Request
2+
description: Suggest an awesome new feature
3+
title: "[Feature]: "
4+
labels: ["enhancement", "✨ feature", "needs-triage"]
5+
projects: ["clever-org-name/2"]
6+
assignees:
7+
- collinmcneese
8+
- scubaninja
9+
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
Thanks for taking the time to suggest a new feature! We appreciate your creativity! 🚀
15+
- type: input
16+
id: contact
17+
attributes:
18+
label: Contact Details
19+
description: How can we get in touch with you if we need more info?
20+
placeholder: ex. email@example.com
21+
validations:
22+
required: false
23+
- type: textarea
24+
id: feature-description
25+
attributes:
26+
label: Feature Description
27+
description: What feature would you like to see added?
28+
placeholder: Describe the feature you'd like to see!
29+
value: "I have an awesome idea!"
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: use-case
34+
attributes:
35+
label: Use Case
36+
description: How would this feature be used? What problem does it solve?
37+
placeholder: Tell us how this feature would help you!
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: alternatives
42+
attributes:
43+
label: Alternatives Considered
44+
description: Have you considered any alternative solutions or features?
45+
placeholder: What other approaches have you thought about?
46+
validations:
47+
required: false
48+
- type: dropdown
49+
id: priority
50+
attributes:
51+
label: Priority
52+
description: How important is this feature to you?
53+
options:
54+
- Nice to have
55+
- Would be helpful
56+
- Really want this
57+
- Critical for my use case
58+
default: 0
59+
validations:
60+
required: true
61+
- type: checkboxes
62+
id: willing-to-contribute
63+
attributes:
64+
label: Contribution
65+
description: Are you willing to help implement this feature?
66+
options:
67+
- label: I'd be willing to contribute to this feature
68+
required: false
69+
- type: checkboxes
70+
id: terms
71+
attributes:
72+
label: Code of Conduct
73+
description: By submitting this issue, you agree to follow our [Code of Conduct](#)
74+
options:
75+
- label: I agree to follow this project's Code of Conduct
76+
required: true

‎.github/ISSUE_TEMPLATE/security-incident.yml‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
name: Security Incident
2+
description: Capture a security incident from runtime telemetry and drive remediation through PRs, pipeline validation, and governance gates.
3+
title: "[Security Incident]: "
4+
labels: ["security", "incident", "triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
## Security Incident
12+
Use this template for runtime security events or suspicious behavior detected by telemetry, API protection, or cloud workload security.
13+
14+
The goal is to link detection → triage → remediation → validation → deployment, with auditability.
15+
16+
- type: input
17+
id: incident_summary
18+
attributes:
19+
label: Incident Summary
20+
description: Short summary of the incident.
21+
placeholder: Example: Suspicious API traffic spike detected on /payments endpoint
22+
validations:
23+
required: true
24+
25+
- type: dropdown
26+
id: severity
27+
attributes:
28+
label: Severity
29+
options:
30+
- Sev 0 (Critical)
31+
- Sev 1 (High)
32+
- Sev 2 (Medium)
33+
- Sev 3 (Low)
34+
validations:
35+
required: true
36+
37+
- type: dropdown
38+
id: status
39+
attributes:
40+
label: Status
41+
options:
42+
- Detected
43+
- Triaging
44+
- Contained
45+
- Remediating
46+
- Validating
47+
- Resolved
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: detection_source
53+
attributes:
54+
label: Detection Source
55+
description: Where did the incident originate?
56+
placeholder: |
57+
Example:
58+
- Microsoft Defender for APIs alert
59+
- Microsoft Defender for Cloud alert
60+
- Azure Application Insights anomaly
61+
- WAF / API gateway alert
62+
validations:
63+
required: true
64+
65+
- type: input
66+
id: telemetry_link
67+
attributes:
68+
label: Telemetry / Alert Link
69+
description: Link to the alert, incident, dashboard, or log query.
70+
placeholder: https://portal.azure.com/...
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: impact_assessment
76+
attributes:
77+
label: Impact Assessment
78+
description: What systems, data, or users are affected?
79+
placeholder: |
80+
Example:
81+
- Potential data exposure: none confirmed
82+
- Affected service: Payment API
83+
- Customer impact: elevated errors for 2% of requests
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
id: containment_actions
89+
attributes:
90+
label: Containment Actions
91+
description: What immediate containment steps were taken?
92+
placeholder: |
93+
Example:
94+
- Disabled feature flag
95+
- Blocked IP ranges
96+
- Rolled back deployment
97+
- Reduced endpoint exposure
98+
validations:
99+
required: true
100+
101+
- type: input
102+
id: related_release
103+
attributes:
104+
label: Related Deployment / Release
105+
description: Link to the deployment or workflow run correlated to this incident.
106+
placeholder: https://github.com/org/repo/actions/runs/123
107+
validations:
108+
required: false
109+
110+
- type: input
111+
id: remediation_pr
112+
attributes:
113+
label: Remediation Pull Request
114+
description: Link to the PR that resolves root cause.
115+
placeholder: https://github.com/org/repo/pull/456
116+
117+
- type: input
118+
id: validation_evidence
119+
attributes:
120+
label: Validation Evidence (Tests / Scans / Gates)
121+
description: Link to workflow run(s), scan results, or gate approvals confirming remediation.
122+
placeholder: https://github.com/org/repo/actions/runs/789
123+
124+
- type: input
125+
id: azure_boards_item
126+
attributes:
127+
label: Azure Boards Work Item
128+
description: Link to Azure Boards item to track incident remediation work.
129+
placeholder: https://dev.azure.com/org/project/_workitems/edit/98765
130+
131+
- type: textarea
132+
id: root_cause
133+
attributes:
134+
label: Root Cause
135+
description: What caused the incident?
136+
placeholder: |
137+
Example:
138+
- Missing authorization check introduced in recent release
139+
- Misconfigured API policy allowing excessive payload size
140+
- Vulnerable dependency exploited
141+
validations:
142+
required: false
143+
144+
- type: textarea
145+
id: corrective_preventative_actions
146+
attributes:
147+
label: Corrective and Preventative Actions
148+
description: How will recurrence be prevented?
149+
placeholder: |
150+
Example:
151+
- Add unit tests for authorization edge cases
152+
- Add API schema validation gate
153+
- Add DAST policy for endpoint class
154+
- Add runtime detection rule
155+
validations:
156+
required: false
157+
158+
- type: checkboxes
159+
id: incident_checks
160+
attributes:
161+
label: Incident Governance Checklist
162+
options:
163+
- label: Incident linked to telemetry evidence
164+
required: true
165+
- label: Containment action documented
166+
required: true
167+
- label: Remediation linked to PR and validation evidence
168+
required: false
169+
- label: Post-incident follow-ups captured (tests, controls, policies)
170+
required: false

0 commit comments

Comments
 (0)