Skip to content

Commit fa17927

Browse files
authored
Merge pull request NixOS#11917 from Pandapip1/update-issue-template-consistent-with-nixpkgs
Update issue and pull request templates
2 parents b767987 + 2f24030 commit fa17927

File tree

5 files changed

+79
-33
lines changed

5 files changed

+79
-33
lines changed
Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,54 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report unexpected or incorrect behaviour
44
title: ''
55
labels: bug
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
## Describe the bug
1111

12-
A clear and concise description of what the bug is.
12+
<!--
13+
A clear and concise description of what the bug is.
1314
14-
If you have a problem with a specific package or NixOS,
15-
you probably want to file an issue at https://github.com/NixOS/nixpkgs/issues.
15+
If you have a problem with a specific package or NixOS,
16+
you probably want to file an issue at https://github.com/NixOS/nixpkgs/issues.
17+
-->
1618

17-
**Steps To Reproduce**
19+
## Steps To Reproduce
1820

19-
1. Go to '...'
20-
2. Click on '....'
21-
3. Scroll down to '....'
22-
4. See error
21+
<!--
22+
Example:
2323
24-
**Expected behavior**
24+
1. Clone this repository: ...
25+
2. Run `nix-... ...`
26+
3. Observe unexpected behaviour
27+
-->
2528

26-
A clear and concise description of what you expected to happen.
29+
## Expected behavior
2730

28-
**`nix-env --version` output**
31+
<!-- A clear and concise description of what you expected to happen. -->
2932

30-
**Additional context**
33+
## Metadata
3134

32-
Add any other context about the problem here.
35+
<!-- Please insert the output of running `nix-env --version` below this line -->
3336

34-
**Priorities**
37+
## Additional context
38+
39+
<!-- Add any other context about the problem here. -->
40+
41+
## Checklist
42+
43+
<!-- make sure this issue is not redundant or obsolete -->
44+
45+
- [ ] checked [latest Nix manual] \([source])
46+
- [ ] checked [open bug issues and pull requests] for possible duplicates
47+
48+
[latest Nix manual]: https://nixos.org/manual/nix/unstable/
49+
[source]: https://github.com/NixOS/nix/tree/master/doc/manual/source
50+
[open bug issues and pull requests]: https://github.com/NixOS/nix/labels/bug
51+
52+
---
3553

3654
Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).
Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,39 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
3+
about: Suggest a new feature
44
title: ''
55
labels: feature
66
assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
## Is your feature request related to a problem?
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1513

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
14+
## Proposed solution
1815

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
16+
<!-- A clear and concise description of what you want to happen. -->
2117

22-
**Priorities**
18+
## Alternative solutions
19+
20+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
21+
22+
## Additional context
23+
24+
<!-- Add any other context or screenshots about the feature request here. -->
25+
26+
## Checklist
27+
28+
<!-- make sure this issue is not redundant or obsolete -->
29+
30+
- [ ] checked [latest Nix manual] \([source])
31+
- [ ] checked [open feature issues and pull requests] for possible duplicates
32+
33+
[latest Nix manual]: https://nixos.org/manual/nix/unstable/
34+
[source]: https://github.com/NixOS/nix/tree/master/doc/manual/source
35+
[open feature issues and pull requests]: https://github.com/NixOS/nix/labels/feature
36+
37+
---
2338

2439
Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).

.github/ISSUE_TEMPLATE/installer.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,25 @@ assignees: ''
2323

2424
<details><summary>Output</summary>
2525

26-
```log
26+
<!-- paste console output inside the below code block -->
2727

28-
<!-- paste console output here and remove this comment -->
28+
```log
2929
3030
```
3131

3232
</details>
3333

34-
## Priorities
34+
## Checklist
35+
36+
<!-- make sure this issue is not redundant or obsolete -->
37+
38+
- [ ] checked [latest Nix manual] \([source])
39+
- [ ] checked [open installer issues and pull requests] for possible duplicates
40+
41+
[latest Nix manual]: https://nixos.org/manual/nix/unstable/
42+
[source]: https://github.com/NixOS/nix/tree/master/doc/manual/source
43+
[open installer issues and pull requests]: https://github.com/NixOS/nix/labels/installer
44+
45+
---
3546

3647
Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).

.github/ISSUE_TEMPLATE/missing_documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ assignees: ''
2626
[source]: https://github.com/NixOS/nix/tree/master/doc/manual/source
2727
[open documentation issues and pull requests]: https://github.com/NixOS/nix/labels/documentation
2828

29-
## Priorities
29+
---
3030

3131
Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ so you understand the process and the expectations.
1717
1818
-->
1919

20-
# Motivation
20+
## Motivation
21+
2122
<!-- Briefly explain what the change is about and why it is desirable. -->
2223

23-
# Context
24+
## Context
25+
2426
<!-- Provide context. Reference open issues if available. -->
2527

2628
<!-- Non-trivial change: Briefly outline the implementation strategy. -->
@@ -29,7 +31,7 @@ so you understand the process and the expectations.
2931

3032
<!-- Large change: Provide instructions to reviewers how to read the diff. -->
3133

32-
# Priorities and Process
34+
---
3335

3436
Add :+1: to [pull requests you find important](https://github.com/NixOS/nix/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc).
3537

0 commit comments

Comments
 (0)