Skip to content

Commit d57b314

Browse files
maleptmalept
authored
chore: use GitHub issue forms (#41)
* chore: use GitHub issue forms for PRs * chore: use GitHub issue forms for bugs * chore: use GitHub issue forms for feature requests
1 parent ca1c721 commit d57b314

6 files changed

+116
-74
lines changed

‎.github/ISSUE_TEMPLATE/bug.md

-37
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Bug report 🐞
2+
description: Create a report to help us improve @malept/cross-spawn-promise
3+
labels: "bug :bug:"
4+
5+
body:
6+
- type: checkboxes
7+
id: checklist
8+
attributes:
9+
label: Pre-flight checklist
10+
options:
11+
- label: I have read the [contribution documentation](https://github.com/malept/cross-spawn-promise/blob/main/CONTRIBUTING.md) for this project.
12+
required: true
13+
- label: I have searched the issue tracker for a bug that matches the one I want to file, without success.
14+
required: true
15+
- type: input
16+
id: module-version
17+
attributes:
18+
label: "`@malept/cross-spawn-promise` version"
19+
description: The output of `npm list @malept/cross-spawn-promise`, e.g., 1.0.0
20+
validations:
21+
required: true
22+
- type: input
23+
id: operating-system
24+
attributes:
25+
label: Operating system
26+
description: Platform and version, for example, macOS 10.13.6 / Windows 10 (1803) / Ubuntu 18.04 x64
27+
validations:
28+
required: true
29+
- type: input
30+
id: last-working-version
31+
attributes:
32+
label: Last known working `@malept/cross-spawn-promise` version
33+
description: e.g., 1.0.0
34+
- type: textbox
35+
id: expected-behavior
36+
attributes:
37+
label: Expected behavior
38+
description: A clear and concise description of what you expected to happen.
39+
validations:
40+
required: true
41+
- type: textbox
42+
id: actual-behavior
43+
attributes:
44+
label: Actual behavior
45+
description: A clear and concise description of what actually happened.
46+
validations:
47+
required: true
48+
- type: textbox
49+
id: steps-to-reproduce
50+
attributes:
51+
label: Steps to reproduce
52+
description: Your best chance of getting this bug looked at quickly is to provide a **minimal** code snippet that can be run and clearly shows the actual behavior described above.
53+
validations:
54+
required: true
55+
- type: textbox
56+
id: additional-information
57+
attributes:
58+
label: Additional information
59+
description: Please add any other context about the problem.

‎.github/ISSUE_TEMPLATE/feature_request.md

-29
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Feature request
2+
description: Suggest an idea for @malept/cross-spawn-promise
3+
labels: "enhancement"
4+
5+
body:
6+
- type: checkboxes
7+
id: checklist
8+
attributes:
9+
label: Pre-flight checklist
10+
options:
11+
- label: I have read the [contribution documentation](https://github.com/malept/cross-spawn-promise/blob/main/CONTRIBUTING.md) for this project.
12+
required: true
13+
- label: I have searched the issue tracker for a feature request that matches the one I want to file, without success.
14+
required: true
15+
- type: textbox
16+
id: problem-description
17+
attributes:
18+
label: Problem description
19+
description: Is your feature request related to a problem? Please add a clear and concise description of what the problem is.
20+
validations:
21+
required: true
22+
- type: textbox
23+
id: proposed-solution
24+
attributes:
25+
label: Proposed solution
26+
description: Describe the solution you'd like in a clear and concise manner.
27+
validations:
28+
required: true
29+
- type: textbox
30+
id: alternatives-considered
31+
attributes:
32+
label: Alternatives considered
33+
description: A clear and concise description of any alternative solutions or features you've considered.
34+
validations:
35+
required: true
36+
- type: textbox
37+
id: additional-information
38+
attributes:
39+
label: Additional information
40+
description: Please add any other context about the problem. This may include the use case for the feature.

‎.github/pull_request_template.md

-8
This file was deleted.

‎.github/pull_request_template.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
body:
2+
- type: textarea
3+
id: description
4+
attributes:
5+
label: Description of change
6+
description: Describe what changes you've made and potential side effects for users.
7+
placeholder: pull request description
8+
- type: checkboxes
9+
id: checklist
10+
attributes:
11+
label: Pre-flight checklist
12+
options:
13+
- label: I have read the [contribution documentation](https://github.com/malept/cross-spawn-promise/blob/main/CONTRIBUTING.md) for this project.
14+
required: true
15+
- label: The changes are appropriately documented (if applicable).
16+
- label: The changes have sufficient test coverage (if applicable).
17+
- label: The testsuite passes successfully on my local machine (if applicable).

0 commit comments

Comments
 (0)