Skip to content

Commit 4c3f63c

Browse files
committed
chore: restructure the issue and PR templates
Bug reports now require the package, React, framework/bundler, browser, and OS versions up front, and both issue forms apply a label on submission. The pull request template swaps the contributing-guide checklist for a related-issue prompt.
1 parent dddd506 commit 4c3f63c

4 files changed

Lines changed: 78 additions & 30 deletions

File tree

Lines changed: 55 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,71 @@
11
name: Bug report
2-
description: Create a report to help us improve
2+
description: Report a reproducible problem
3+
labels: ["bug"]
34
body:
45
- type: textarea
6+
id: summary
57
attributes:
6-
label: Describe the bug
7-
description: A clear and concise description of what the bug is.
8+
label: Summary
9+
description: Describe the issue you're experiencing.
810
validations:
911
required: true
10-
- type: textarea
12+
13+
- type: input
14+
id: package-version
1115
attributes:
12-
label: Expected behavior
13-
description: A clear and concise description of what you expected to happen.
16+
label: react-photo-album version
17+
placeholder: e.g., 3.6.1
1418
validations:
1519
required: true
16-
- type: textarea
20+
21+
- type: input
22+
id: react-version
23+
attributes:
24+
label: React version
25+
placeholder: e.g., 19.2.0
26+
validations:
27+
required: true
28+
29+
- type: input
30+
id: framework
31+
attributes:
32+
label: Framework / bundler
33+
placeholder: e.g., Next.js 16.1.0, Vite 8.0.0
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: browser
1739
attributes:
18-
label: How to reproduce
19-
description: If applicable, add links or code snippets demonstrating the issue.
40+
label: Browser
41+
placeholder: e.g., Chrome 148, Safari 26.3.1
2042
validations:
2143
required: true
44+
45+
- type: input
46+
id: os
47+
attributes:
48+
label: Operating system
49+
placeholder: e.g., macOS 26.4.1
50+
validations:
51+
required: true
52+
2253
- type: textarea
54+
id: repro
2355
attributes:
24-
label: Screenshots / Logs
25-
description: If applicable, add screenshots and logs to help explain your problem.
56+
label: Minimal reproduction
57+
description: |
58+
Provide a link to a live reproduction (StackBlitz, CodeSandbox, or a public repository),
59+
or share code snippets and steps to reproduce. Keep it as small as possible.
60+
validations:
61+
required: true
62+
2663
- type: textarea
64+
id: expected-vs-actual
2765
attributes:
28-
label: Additional context
29-
description: Add any other context about the problem here.
66+
label: Expected vs. actual behavior
67+
description: |
68+
Describe what you expected to happen and what actually happened.
69+
Include screenshots or error output where relevant.
70+
validations:
71+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Question
44
url: https://github.com/igordanchenko/react-photo-album/discussions/categories/q-a
5-
about: Please post questions under the Q&A category in Discussions
6-
- name: Suggestion
5+
about: Ask usage questions in the Q&A category
6+
- name: Idea
77
url: https://github.com/igordanchenko/react-photo-album/discussions/categories/ideas
8-
about: Please post suggestions or ideas under the Ideas category in Discussions
9-
- name: General
8+
about: Share suggestions or ideas in the Ideas category
9+
- name: General discussion
1010
url: https://github.com/igordanchenko/react-photo-album/discussions/categories/general
11-
about: Please post general discussions under the General category in Discussions
11+
about: Start a General discussion for anything else
Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
name: Feature request
2-
description: Suggest an enhancement for this project
2+
description: Suggest an enhancement or a new capability
3+
labels: ["enhancement"]
34
body:
45
- type: textarea
6+
id: problem
57
attributes:
6-
label: Is your feature request related to a problem? Please describe.
7-
description: A clear and concise description of what the problem is.
8+
label: Problem
9+
description: What are you trying to achieve, and what is getting in the way?
810
validations:
911
required: true
12+
1013
- type: textarea
14+
id: proposal
1115
attributes:
12-
label: Describe the solution you'd like
13-
description: A clear and concise description of what you want to happen.
14-
validations:
15-
required: true
16+
label: Proposed solution
17+
description: What would a good solution look like? Skip this if you're unsure.
18+
1619
- type: textarea
20+
id: alternatives
1721
attributes:
18-
label: Describe alternatives you've considered
19-
description: A clear and concise description of any alternative solutions or features you've considered.
22+
label: Alternatives considered
23+
description: Describe any workarounds or alternative approaches you've considered.
24+
2025
- type: textarea
26+
id: context
2127
attributes:
2228
label: Additional context
23-
description: Add any other context or screenshots about the feature request here.
29+
description: Anything else worth knowing — links, prior art, or related issues.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
<!-- Please describe your PR here -->
44

5-
### Checklist
5+
### Related issue
66

7-
- [ ] I have followed the 'Sending a Pull Request' section of the [contributing guide](https://github.com/igordanchenko/react-photo-album/blob/main/CONTRIBUTING.md#sending-a-pull-request)
7+
<!-- Closes #123, or "n/a" for trivial changes -->

0 commit comments

Comments
 (0)