Skip to content

Commit dd0d522

Browse files
authored
github: add issue template forms (#1764)
Convert our existing issue templates to [forms][1] to make it easier to get helpful bug/feature info. Issues created from a template will have a `triage` label applied by default, indicating that it needs to be looked at by someone from the team. After an issue has been triaged/validated, this label should be removed. Hopefully this will make it easier to track issues that are ready to be worked on. [1]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
1 parent 7796d01 commit dd0d522

File tree

8 files changed

+177
-74
lines changed

8 files changed

+177
-74
lines changed

.github/ISSUE_TEMPLATE/01-bug.yaml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels:
4+
- bug
5+
- triage
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: What happened?
11+
description: >-
12+
Also include what you expected to happen and any other relevant details.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: repro
17+
attributes:
18+
label: Steps to reproduce
19+
description: >-
20+
What specific steps can we take to reproduce this issue?
21+
Including a script would be much appreciated!
22+
value: |
23+
1.
24+
2.
25+
3.
26+
- type: dropdown
27+
id: commands
28+
attributes:
29+
label: Command
30+
description: What Devbox command were you running when the bug occurred?
31+
multiple: true
32+
options:
33+
- add
34+
- auth
35+
- create
36+
- generate
37+
- global
38+
- info
39+
- init
40+
- install
41+
- rm
42+
- run
43+
- search
44+
- services
45+
- shell
46+
- shellenv
47+
- update
48+
- version
49+
- type: textarea
50+
id: devbox-json
51+
attributes:
52+
label: devbox.json
53+
description: Please include a copy of your devbox.json file.
54+
render: "jsonc"
55+
- type: input
56+
id: devbox-version
57+
attributes:
58+
label: Devbox version
59+
description: "Paste the output of `devbox version`."
60+
validations:
61+
required: true
62+
- type: input
63+
id: nix-version
64+
attributes:
65+
label: Nix version
66+
description: "Paste the output of `nix --version`."
67+
- type: dropdown
68+
id: system
69+
attributes:
70+
label: What system does this bug occur on?
71+
options:
72+
- macOS (Intel)
73+
- macOS (Apple Silicon)
74+
- Linux (x86-64)
75+
- Linux (ARM64)
76+
- Other (please include in the description above)
77+
validations:
78+
required: true
79+
- type: textarea
80+
id: logs
81+
attributes:
82+
label: Debug logs
83+
description: >-
84+
If possible, reproduce the bug with the `DEVBOX_DEBUG=1` environment
85+
variable set and paste any output here.
86+
For example: `DEVBOX_DEBUG=1 devbox run -- mycrash.sh`.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature Request
2+
description: Suggest an idea or new feature
3+
labels:
4+
- feature
5+
- triage
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: What problem are you trying to solve?
11+
description: >-
12+
Describe the problem you're trying to solve with this feature.
13+
placeholder: I'm always frustrated when...
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: solution
18+
attributes:
19+
label: What solution would you like?
20+
description: >-
21+
Describe the feature you would like to see implemented and explain how
22+
it would address the problem you described above.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: alternatives
27+
attributes:
28+
label: Alternatives you've considered
29+
description: >-
30+
Describe any alternative solutions or features you've considered. If you
31+
know of any similar features requested before, please include links to
32+
them.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Package Issue
2+
description: Report a problem with an existing package on either Devbox or Nixhub
3+
labels:
4+
- package
5+
- bug
6+
- triage
7+
body:
8+
- type: input
9+
id: name
10+
attributes:
11+
label: Package name
12+
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: solution
17+
attributes:
18+
label: What changes are you requesting?
19+
description: >-
20+
Describe what's going wrong or what changes you'd like to see to the
21+
package.
22+
validations:
23+
required: true
24+
- type: input
25+
id: link
26+
attributes:
27+
label: Nixhub link
28+
placeholder: https://www.nixhub.io/packages/go
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Package Request
2+
description: Request a new package to be added to Devbox and Nixhub
3+
labels:
4+
- package
5+
- triage
6+
body:
7+
- type: input
8+
id: name
9+
attributes:
10+
label: Package name
11+
description: What name are you requesting for the new package?
12+
validations:
13+
required: true
14+
- type: input
15+
id: nixpkgs
16+
attributes:
17+
label: Nix package link
18+
description: >-
19+
Are you able to find the package on https://search.nixos.org/packages?
20+
If so, please include a link to the search results. Otherwise, leave
21+
blank.
22+
- type: textarea
23+
id: software
24+
attributes:
25+
label: Software
26+
description: >-
27+
Provide a description of the software that should be added to the new
28+
package. Include any relevant links such as websites,
29+
GitHub repositories, etc.
30+
validations:
31+
required: true

.github/ISSUE_TEMPLATE/bugs.md

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

.github/ISSUE_TEMPLATE/feature-request.md

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

.github/ISSUE_TEMPLATE/package-issue.md

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

.github/ISSUE_TEMPLATE/plugin-request.md

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

0 commit comments

Comments
 (0)