Skip to content

Commit e2151c6

Browse files
trueberrylessnatemoo-reghostdevv
authored
feat: add generalized issue and PR templates (#8)
* feat: add generalized issue and PR templates * fix: suggestion Co-authored-by: Nate Moore <7118177+natemoo-re@users.noreply.github.com> * feat: add AI disclosures Co-authored-by: Nate Moore <7118177+natemoo-re@users.noreply.github.com> * fix: suggestion Co-authored-by: Willow (GHOST) <47755378+ghostdevv@users.noreply.github.com> --------- Co-authored-by: Nate Moore <7118177+natemoo-re@users.noreply.github.com> Co-authored-by: Willow (GHOST) <47755378+ghostdevv@users.noreply.github.com>
1 parent d0ca080 commit e2151c6

4 files changed

Lines changed: 168 additions & 0 deletions

File tree

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: "\U0001F41B Bug report"
2+
description: Create a report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: input
10+
id: package
11+
attributes:
12+
label: Package
13+
description: Which package is this bug related to?
14+
placeholder: e.g. @clack/core
15+
validations:
16+
required: true
17+
- type: input
18+
id: package-version
19+
attributes:
20+
label: Package Version
21+
description: What version of the package are you using? (e.g., v0.2.0)
22+
placeholder: vX.Y.Z
23+
validations:
24+
required: true
25+
- type: input
26+
id: node-version
27+
attributes:
28+
label: Node.js Version
29+
description: Run `node -v` in your terminal.
30+
placeholder: v24.13.0
31+
validations:
32+
required: true
33+
- type: input
34+
id: os
35+
attributes:
36+
label: Operating System
37+
placeholder: e.g. macOS, Windows, Linux
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: description
42+
attributes:
43+
label: Describe the bug
44+
description: A clear and concise description of what the bug is.
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: reproduction
49+
attributes:
50+
label: To Reproduce
51+
description: |
52+
Please provide a link to a minimal reproduction using [node.new](https://node.new/) and list the steps to reproduce the behavior below.
53+
placeholder: |
54+
Reproduction link:
55+
56+
Steps to reproduce:
57+
1.
58+
2.
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: expected-behavior
63+
attributes:
64+
label: Expected behavior
65+
description: A clear and concise description of what you expected to happen.
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: additional-info
70+
attributes:
71+
label: Additional Information
72+
description: If applicable, add screenshots or any other context to help explain your problem.
73+
validations:
74+
required: false
75+
- type: checkboxes
76+
id: ai-disclosure
77+
attributes:
78+
label: AI assistance disclosure
79+
options:
80+
- label: This bug report was drafted with the assistance of an AI tool.
81+
required: false

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: "\U0001F4AC Discord Chat"
4+
url: https://bomb.sh/chat
5+
about: Our Discord server is active, come join us for support and chat!
6+
- name: "\U0001F98B Bluesky"
7+
url: https://bsky.app/profile/bomb.sh
8+
about: Follow us on Bluesky for updates, news, and announcements.
9+
- name: "\U0001F496 Sponsor"
10+
url: https://opencollective.com/bombshell-dev
11+
about: Support the development of bombshell projects via Open Collective!
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "\U0001F4A1 Feature request"
2+
description: Suggest an idea for this project
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Have an idea to improve one of our packages? We'd love to hear it!
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: Is your feature request related to a problem?
13+
description: A clear and concise description of what the problem is (e.g., "I'm always frustrated when...").
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: solution
18+
attributes:
19+
label: Describe the solution you'd like
20+
description: A clear and concise description of what you want to happen.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Describe alternatives you've considered
27+
description: A clear and concise description of any alternative solutions or features you've considered.
28+
validations:
29+
required: false
30+
- type: textarea
31+
id: context
32+
attributes:
33+
label: Additional context
34+
description: Add any other context, code examples, or screenshots about the feature request here.
35+
validations:
36+
required: false
37+
- type: checkboxes
38+
id: ai-disclosure
39+
attributes:
40+
label: AI assistance disclosure
41+
options:
42+
- label: This feature request was drafted with the assistance of an AI tool.
43+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## What does this PR do?
2+
3+
<!--
4+
Describe the change and why it's needed. Link to a related issue or discussion.
5+
If there is no issue, please explain why one isn't needed.
6+
-->
7+
8+
Closes #
9+
10+
## Type of change
11+
12+
<!-- Check one. -->
13+
14+
- [ ] Bug fix
15+
- [ ] Feature
16+
- [ ] Refactor (no behavior change)
17+
- [ ] Documentation
18+
- [ ] Performance improvement
19+
- [ ] Tests
20+
- [ ] Chore (dependencies, CI, tooling)
21+
22+
## Checklist
23+
24+
- [ ] All tests pass (`pnpm test`)
25+
- [ ] Files are formatted (`pnpm format`)
26+
- [ ] I have added/updated tests for my changes (if applicable)
27+
- [ ] I have added a changeset
28+
29+
## AI-generated code disclosure
30+
31+
<!-- If any part of this PR was generated by AI tools (Copilot, Claude, GPT, Cursor, etc.), check the box. This is fine — we just need to know so reviewers can pay extra attention to edge cases. -->
32+
33+
- [ ] This PR includes AI-generated code

0 commit comments

Comments
 (0)