Skip to content

Commit bbb11bc

Browse files
committed
saner issue and pull request template
1 parent 02ff898 commit bbb11bc

File tree

4 files changed

+63
-40
lines changed

4 files changed

+63
-40
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Bug Report
2+
description: Something isn't working
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
id: what
7+
attributes:
8+
label: What happened?
9+
placeholder: Describe the bug
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: repro
14+
attributes:
15+
label: Reproduction
16+
description: Minimal code or steps to reproduce
17+
placeholder: |
18+
```ts
19+
import { chunk } from 'code-chunk'
20+
// ...
21+
```
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: expected
26+
attributes:
27+
label: Expected behavior
28+
placeholder: What should have happened?
29+
validations:
30+
required: false
31+
- type: input
32+
id: version
33+
attributes:
34+
label: Version
35+
placeholder: e.g. 1.0.0
36+
validations:
37+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Feature Request
2+
description: Suggest an idea
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem
9+
description: What problem does this solve?
10+
placeholder: I want to...
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: solution
15+
attributes:
16+
label: Proposed solution
17+
placeholder: How would you solve it?
18+
validations:
19+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,11 @@
1-
## Description
1+
## What
22

3-
<!-- Briefly describe what this PR does -->
3+
<!-- What does this PR do? One sentence. -->
44

5-
## Type of Change
5+
## Why
66

7-
<!-- Check the relevant option -->
7+
<!-- Why is this needed? Link issue if exists: Fixes #123 -->
88

9-
- [ ] 🐛 Bug fix
10-
- [ ] ✨ New feature
11-
- [ ] 💥 Breaking change
12-
- [ ] 📝 Documentation
13-
- [ ] ♻️ Refactoring
14-
- [ ] ⚡ Performance
15-
- [ ] ✅ Tests
16-
- [ ] 🔧 Build/CI
9+
## Notes
1710

18-
## Related Issues
19-
20-
<!-- Link related issues: Fixes #123, Closes #456 -->
21-
22-
## Changes
23-
24-
<!-- List key changes -->
25-
26-
-
27-
-
28-
29-
## Testing
30-
31-
<!-- How did you test this? -->
32-
33-
- [ ] Tests added/updated
34-
- [ ] All tests passing
35-
36-
## Checklist
37-
38-
- [ ] Code follows project style
39-
- [ ] Self-reviewed
40-
- [ ] Documentation updated (if needed)
41-
- [ ] No breaking changes (or documented)
42-
43-
## Screenshots/Notes
44-
45-
<!-- Optional: Add screenshots or additional context -->
11+
<!-- Anything reviewers should know? Delete if n/a -->

0 commit comments

Comments
 (0)