Skip to content

Commit 6d8a31b

Browse files
committed
Migrate to GitHub issue forms
1 parent 27ca9e8 commit 6d8a31b

File tree

5 files changed

+118
-31
lines changed

5 files changed

+118
-31
lines changed

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
labels: [":bug: bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
id: what-happened
11+
attributes:
12+
label: 👓 What did you see?
13+
description: A clear and concise description of what you saw happen.
14+
placeholder: Tell us what you see!
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: what-was-expected
19+
attributes:
20+
label: ✅ What did you expect to see?
21+
description: Describe what you would like to have happen instead.
22+
placeholder: Tell us what you expected to see!
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: version
27+
attributes:
28+
label: 📦 Which package version are you using?
29+
description: What version of our software are you running?
30+
placeholder: |
31+
python 3.12.0
32+
pysamplelib 0.1.0
33+
- type: textarea
34+
id: how-to-reproduce
35+
attributes:
36+
label: 🔬 How could we reproduce it?
37+
description: >
38+
It order to fix the problem, we need to be able to reproduce it.
39+
A [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) can be really helpful for anyone
40+
trying to diagnose and fix the problem.
41+
42+
43+
Please outline the steps below:
44+
placeholder: |
45+
1. Install '...' version '...'
46+
2. Create a file called '....'
47+
3. Run command '....'
48+
4. See error '....'
49+
- type: textarea
50+
id: context
51+
attributes:
52+
label: 📚 Any additional context?
53+
description: Add any other context, references, logs or screenshots about the problem here.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Developer Experience
2+
description: >
3+
Refactoring or technical debt payback that makes the codebase more
4+
pleasant to work on
5+
labels: [":bank: debt"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Thanks for suggesting an improvement to the code!
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: 🤔 What's the problem you've observed?
14+
placeholder: Add your observations here...
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: proposal
19+
attributes:
20+
label: ✨ Do you have a proposal for making it better?
21+
placeholder: Add your suggestions here...
22+
- type: textarea
23+
id: context
24+
attributes:
25+
label: 📚 Any additional context?
26+
placeholder: >
27+
Add any other context, references or screenshots here.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
labels: [":zap: enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Thanks for taking the time to suggest an idea for this project!
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: 🤔 What's the problem you're trying to solve?
13+
description: >
14+
A clear and concise description of what the problem is e.g. I'm
15+
always frustrated when ...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: proposal
20+
attributes:
21+
label: ✨ What's your proposed solution?
22+
description: A clear and concise description of what you want to happen.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: alternatives
27+
attributes:
28+
label: ⛏ Have you considered any alternatives or workarounds?
29+
description: >
30+
A clear and concise description of any alternative solutions or features
31+
you've considered.
32+
- type: textarea
33+
id: context
34+
attributes:
35+
label: 📚 Any additional context?
36+
description: >
37+
Add any other context, references or screenshots about the feature
38+
request here.

0 commit comments

Comments
 (0)