Skip to content

Commit 8f710b3

Browse files
committed
Extend issue forms
1 parent 2ee2af8 commit 8f710b3

File tree

3 files changed

+45
-24
lines changed

3 files changed

+45
-24
lines changed

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ labels: [":bug: bug"]
44
body:
55
- type: markdown
66
attributes:
7-
value: >
8-
Thanks for taking the time to fill out this bug report!
7+
value: |-
8+
Thanks for letting us know about a bug! 💖
9+
10+
Use the questions below to help explain what you think is wrong, and what we should do to fix it.
911
- type: textarea
1012
id: what-happened
1113
attributes:
@@ -18,36 +20,42 @@ body:
1820
id: what-was-expected
1921
attributes:
2022
label: ✅ What did you expect to see?
21-
description: Describe what you would like to have happen instead.
23+
description: Describe what you would like to have happened instead.
2224
placeholder: Tell us what you expected to see!
2325
validations:
2426
required: true
2527
- type: textarea
2628
id: version
2729
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
30+
label: 📦 Which tool/library version are you using?
31+
description: What version of Cucumber/GoDog/etc. are you running? What version of your programming language platform? Anything else that might be relevant?
32+
placeholder: |-
33+
node v18.17.0
34+
cucumber-js v10.3.2
3335
- type: textarea
3436
id: how-to-reproduce
3537
attributes:
3638
label: 🔬 How could we reproduce it?
37-
description: >
39+
description: |-
3840
It order to fix the problem, we need to be able to reproduce it.
41+
3942
A [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) can be really helpful for anyone
4043
trying to diagnose and fix the problem.
4144
42-
43-
Please outline the steps below:
44-
placeholder: |
45+
Please outline the steps below.
46+
placeholder: |-
4547
1. Install '...' version '...'
46-
2. Create a file called '....'
47-
3. Run command '....'
48-
4. See error '....'
48+
2. Create a file called '...'
49+
3. Run command '...'
50+
4. See error '...'
51+
52+
Include screenshots if that would be helpful.
4953
- type: textarea
5054
id: context
5155
attributes:
5256
label: 📚 Any additional context?
5357
description: Add any other context, references, logs or screenshots about the problem here.
58+
- type: markdown
59+
attributes:
60+
value: |-
61+
*This text was originally generated from a [template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates), then edited by hand. [You can modify the template here.](https://github.com/cucumber/.github/edit/main/.github/ISSUE_TEMPLATE/bug_report.yaml)*

.github/ISSUE_TEMPLATE/developer_experience.yaml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
name: Developer Experience
22
description: >
3-
Refactoring or technical debt payback that makes the codebase more
4-
pleasant to work on
3+
Refactoring or technical debt payback that makes the codebase more pleasant to work on
54
labels: [":bank: debt"]
65
body:
76
- type: markdown
87
attributes:
9-
value: Thanks for suggesting an improvement to the code!
8+
value: |-
9+
Thanks for suggesting an improvement to the code!
10+
11+
Use the questions below to help explain why you think this change is needed.
1012
- type: textarea
1113
id: problem
1214
attributes:
@@ -25,3 +27,8 @@ body:
2527
label: 📚 Any additional context?
2628
placeholder: >
2729
Add any other context, references or screenshots here.
30+
- type: markdown
31+
attributes:
32+
value: >
33+
*This text was originally generated from a [template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates), then edited by hand. [You can modify the template here.](https://github.com/cucumber/.github/edit/main/.github/ISSUE_TEMPLATE/developer_experience.yaml)*
34+

.github/ISSUE_TEMPLATE/feature_request.yaml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ labels: [":zap: enhancement"]
44
body:
55
- type: markdown
66
attributes:
7-
value: >
8-
Thanks for taking the time to suggest an idea for this project!
7+
value: |-
8+
Thanks for suggesting an improvement to Cucumber! 💖
9+
10+
Use the questions below to help explain why you think this change is needed.
911
- type: textarea
1012
id: problem
1113
attributes:
1214
label: 🤔 What's the problem you're trying to solve?
1315
description: >
14-
A clear and concise description of what the problem is e.g. I'm
15-
always frustrated when ...
16+
A clear and concise description of what the problem is.
17+
placeholder: I'm always frustrated when ...
1618
validations:
1719
required: true
1820
- type: textarea
@@ -34,5 +36,9 @@ body:
3436
attributes:
3537
label: 📚 Any additional context?
3638
description: >
37-
Add any other context, references or screenshots about the feature
38-
request here.
39+
Add any other context, references or screenshots about the feature request here.
40+
- type: markdown
41+
attributes:
42+
value: |-
43+
*This text was originally generated from a [template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates), then edited by hand. [You can modify the template here.](https://github.com/cucumber/.github/edit/main/.github/ISSUE_TEMPLATE/feature_request.yaml)*
44+

0 commit comments

Comments
 (0)