Skip to content
This repository was archived by the owner on Apr 4, 2026. It is now read-only.

Commit 1070596

Browse files
KTrain5169KTrain5169
committed
chore: issue forms
1 parent 17d2b70 commit 1070596

3 files changed

Lines changed: 208 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/1-bug-report.yml‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: "Bug report"
2+
description: "Use this form to report bugs found in the monorepo (browser extension, dashboard, or API). Please provide reproduction steps, environment, and any logs or screenshots."
3+
title: "[bug] "
4+
labels:
5+
- "bug"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thanks for filing a bug! To help us triage and fix this quickly, please fill out the fields below with as much detail as you can. If the bug affects multiple components, please create one report per component when possible.
11+
12+
- type: input
13+
id: short_description
14+
attributes:
15+
label: "Short description"
16+
description: "A one-line summary of the bug."
17+
placeholder: "e.g. Extension crashes when using X feature"
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: component
23+
attributes:
24+
label: "Affected component"
25+
description: "Which part does this bug affect?"
26+
options:
27+
- Extension
28+
- Dashboard
29+
- API
30+
31+
- type: textarea
32+
id: steps_to_reproduce
33+
attributes:
34+
label: "Steps to reproduce"
35+
description: "Step-by-step instructions to reproduce the bug (include exact menu selections, inputs, or API calls)."
36+
placeholder: |
37+
1. Go to ...
38+
2. Click ...
39+
3. Observe ...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: expected_behavior
45+
attributes:
46+
label: "Expected behavior"
47+
description: "What you expected to happen."
48+
placeholder: "Describe the intended behaviour here."
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: actual_behavior
54+
attributes:
55+
label: "Actual behavior"
56+
description: "What actually happened (include error messages, incorrect UI state, etc.)."
57+
validations:
58+
required: true
59+
60+
- type: input
61+
id: version_or_sha
62+
attributes:
63+
label: "Version"
64+
description: "Version where the bug was observed. If unknown, leave blank."
65+
placeholder: "e.g. v1.2.3"
66+
validations:
67+
required: true
68+
69+
- type: input
70+
id: environment
71+
attributes:
72+
label: "Environment (browser / OS / Node / DB)"
73+
description: "Browser and OS for extension/dashboard (e.g. Chrome 116 on macOS 14), or runtime details for the API (Node version, DB)."
74+
placeholder: "e.g. Chrome 116 / macOS 14.1 or Node 18 / Postgres 15"
75+
76+
- type: checkboxes
77+
id: severity
78+
attributes:
79+
label: "Severity (how badly does this block usage?)"
80+
options:
81+
- label: "Blocker — blocks core functionality"
82+
- label: "High — major feature broken"
83+
- label: "Medium — partial loss of functionality"
84+
- label: "Low — minor issue / cosmetic"
85+
86+
- type: textarea
87+
id: logs_and_traces
88+
attributes:
89+
label: "Relevant logs / stack traces / network requests"
90+
render: shell
91+
description: "Paste logs, stack traces, or curl requests here. Wrap code with triple backticks. For large files, attach them below."
92+
placeholder: "Error: ...\n at ..."
93+
94+
- type: textarea
95+
id: attachments
96+
attributes:
97+
label: "Screenshots, recordings, or other files"
98+
description: "Attach screenshots, HAR files, recordings, or other helpful files."
99+
100+
- type: textarea
101+
id: additional_context
102+
attributes:
103+
label: "Additional context"
104+
description: "Anything else that might help (related issues, recent changes, reproducibility frequency)."
105+
106+
- type: markdown
107+
attributes:
108+
value: >
109+
**Thanks!** After submitting, the maintainers will triage the issue. If your report includes sensitive data (API keys, personal data), please remove or redact it before attaching.

‎.github/ISSUE_TEMPLATE/2-feature-request.yml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: "Feature request"
2+
description: "Request a new feature or improvement for the monorepo (browser extension, dashboard, or API). Include motivation, proposed design, and acceptance criteria when possible."
3+
title: "[feat]"
4+
labels:
5+
- "enhancement"
6+
- "feature-request"
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: >
11+
Thanks for suggesting a feature! To help us evaluate and prioritise it, please provide use cases, a proposed solution (or mockups), and an idea of scope/effort.
12+
13+
- type: input
14+
id: short_description
15+
attributes:
16+
label: "Short description"
17+
description: "One-line summary of the feature."
18+
placeholder: "e.g. Add dark-mode toggle to dashboard"
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: component
24+
attributes:
25+
label: "Affected component"
26+
description: "Which part of the monorepo would this feature touch?"
27+
multiple: true
28+
options:
29+
- Extension
30+
- Dashboard
31+
- API
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: user_story
37+
attributes:
38+
label: "Use cases"
39+
description: "Who benefits and how? Provide concrete scenarios."
40+
placeholder: "As a <role>, I want <feature> so that <benefit>."
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: proposed_solution
46+
attributes:
47+
label: "Proposed solution / design"
48+
description: "Describe how the feature could be implemented. Include API shape, UI mockups, or acceptance criteria if available."
49+
placeholder: "Describe endpoints, UI changes, or provide a quick sketch."
50+
51+
- type: textarea
52+
id: success_criteria
53+
attributes:
54+
label: "Success / acceptance criteria"
55+
description: "How will we know this feature is complete? List measurable criteria."
56+
placeholder: "e.g. Toggle persists across sessions; API returns x/y; unit tests cover …"
57+
58+
- type: textarea
59+
id: alternatives
60+
attributes:
61+
label: "Alternatives considered"
62+
description: "Other approaches you considered and why this one is preferred."
63+
validations:
64+
required: true
65+
66+
- type: dropdown
67+
id: estimated_effort
68+
attributes:
69+
label: "Estimated implementation effort"
70+
options:
71+
- Small (patch)
72+
- Medium (minor)
73+
- Large (major)
74+
75+
- type: input
76+
id: related_issues
77+
attributes:
78+
label: "Related issues / PRs"
79+
description: "Comma-separated list of related issue numbers or PRs (optional)."
80+
placeholder: "#123, #456"
81+
82+
- type: textarea
83+
id: additional_context
84+
attributes:
85+
label: "Additional context"
86+
description: "Anything else that will help reviewers (mostly timing constraints)."
87+
88+
- type: markdown
89+
attributes:
90+
value: >
91+
**Thanks!** After submitting, maintainers will review for scope and prioritisation. If the feature includes any sensitive data please redact it before attaching.

‎.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: false
2+
contact_links:
3+
- name: Report a site
4+
url: https://smc.example.com/report
5+
about: Report a site using this link, or request a site review.
6+
- name: Security issues
7+
url: https://github.com/StopMalwareContent/Code/security
8+
about: DO NOT REPORT SECURITY ISSUES PUBLICLY, instead please visit this link.

0 commit comments

Comments
 (0)