Skip to content

Commit 5607c4d

Browse files
committed
chore: add issue and PR templates
Bug report and feature request templates only — no blank issues, no support requests. PR template with test checklist.
1 parent 8d604f1 commit 5607c4d

4 files changed

Lines changed: 83 additions & 0 deletions

File tree

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Bug Report
2+
description: Report a bug in the sanitizer
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**This tracker is for bugs only.** For support questions, visit the relevant community channels (e.g., Discord, forums).
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: What happened?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: expected
18+
attributes:
19+
label: Expected behavior
20+
description: What should have happened?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: input
25+
attributes:
26+
label: Input YAML (sanitized)
27+
description: Paste a minimal example that reproduces the issue. Redact any real secrets first.
28+
render: yaml
29+
- type: textarea
30+
id: output
31+
attributes:
32+
label: Actual output
33+
description: What the sanitizer produced
34+
render: yaml
35+
- type: input
36+
id: browser
37+
attributes:
38+
label: Browser
39+
description: e.g., Chrome 120, Firefox 121, Safari 17

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
blank_issues_enabled: false
2+
contact_links: []
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature Request
2+
description: Suggest an improvement or new feature
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**This tracker is for feature requests only.** For support questions, visit the relevant community channels.
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: What would you like to see added or changed?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: use-case
18+
attributes:
19+
label: Use case
20+
description: Why is this needed? What problem does it solve?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Alternatives considered
27+
description: Have you considered any workarounds?

‎.github/pull_request_template.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
3+
<!-- Brief description of changes -->
4+
5+
## Changes
6+
7+
<!-- Bullet list of what changed -->
8+
9+
## Test plan
10+
11+
<!-- How to verify this works -->
12+
13+
- [ ] Tests pass (`npm test`)
14+
- [ ] TypeScript compiles (`npx tsc --noEmit`)
15+
- [ ] Build succeeds (`npm run build`)

0 commit comments

Comments
 (0)