.github: Use consistent (and correct) formatting across issue templates

This commit is contained in:
Gavin John 2024-11-09 01:17:56 -08:00
parent f8486a3f1d
commit d385091084
No known key found for this signature in database
GPG Key ID: 792E158CDD33C3EE
7 changed files with 86 additions and 40 deletions

View File

@ -7,34 +7,44 @@ assignees: ''
--- ---
### Describe the bug ## Describe the bug
A clear and concise description of what the bug is.
<!-- A clear and concise description of what the bug is. -->
## Steps To Reproduce
### Steps To Reproduce
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. ... 1. ...
2. ... 2. ...
3. ... 3. ...
### Expected behavior ## Expected behavior
A clear and concise description of what you expected to happen.
### Screenshots <!-- A clear and concise description of what you expected to happen. -->
If applicable, add screenshots to help explain your problem.
### Additional context ## Screenshots
Add any other context about the problem here.
### Notify maintainers <!-- If applicable, add screenshots to help explain your problem: -->
## Additional context
<!-- Add any other context about the problem here. -->
## Metadata
<!-- Please insert the output of running `nix-shell -p nix-info --run "nix-info -m"` below this line -->
## Notify maintainers
<!-- <!--
Please @ people who are in the `meta.maintainers` list of the offending package or module. Please @ people who are in the `meta.maintainers` list of the offending package or module.
If in doubt, check `git blame` for whoever last touched something. If in doubt, check `git blame` for whoever last touched something.
--> -->
### Metadata ---
<!-- Please insert the output of running `nix-shell -p nix-info --run "nix-info -m"` below this line --> Note for maintainers: Please tag this issue in your PR.
--- ---

View File

@ -7,31 +7,43 @@ assignees: ''
--- ---
### Steps To Reproduce ## Steps To Reproduce
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. build *X* 1. build *X*
### Build log ## Build log
<!-- insert build log in code block in collapsable section -->
<details>
<summary>Build Log</summary>
``` ```
log here if short otherwise a link to a gist
``` ```
### Additional context </details>
Add any other context about the problem here. ## Additional context
### Notify maintainers <!-- Add any other context about the problem here. -->
## Metadata
<!-- Please insert the output of running `nix-shell -p nix-info --run "nix-info -m"` below this line -->
## Notify maintainers
<!-- <!--
Please @ people who are in the `meta.maintainers` list of the offending package or module. Please @ people who are in the `meta.maintainers` list of the offending package or module.
If in doubt, check `git blame` for whoever last touched something. If in doubt, check `git blame` for whoever last touched something.
--> -->
### Metadata ---
<!-- Please insert the output of running `nix-shell -p nix-info --run "nix-info -m"` below this line --> Note for maintainers: Please tag this issue in your PR.
--- ---

View File

@ -23,12 +23,9 @@ assignees: ''
- [ ] checked [open documentation issues] for possible duplicates - [ ] checked [open documentation issues] for possible duplicates
- [ ] checked [open documentation pull requests] for possible solutions - [ ] checked [open documentation pull requests] for possible solutions
[latest Nixpkgs manual]: https://nixos.org/manual/nixpkgs/unstable/ ---
[latest NixOS manual]: https://nixos.org/manual/nixos/unstable/
[nixpkgs-source]: https://github.com/NixOS/nixpkgs/tree/master/doc Note for maintainers: Please tag this issue in your PR.
[nixos-source]: https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual
[open documentation issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+label%3A%229.needs%3A+documentation%22
[open documentation pull requests]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+documentation%22%2C%226.topic%3A+documentation%22
--- ---
@ -36,3 +33,9 @@ Add a :+1: [reaction] to [issues you find important].
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
[issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc [issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc
[latest Nixpkgs manual]: https://nixos.org/manual/nixpkgs/unstable/
[latest NixOS manual]: https://nixos.org/manual/nixos/unstable/
[nixpkgs-source]: https://github.com/NixOS/nixpkgs/tree/master/doc
[nixos-source]: https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual
[open documentation issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+label%3A%229.needs%3A+documentation%22
[open documentation pull requests]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+documentation%22%2C%226.topic%3A+documentation%22

View File

@ -7,11 +7,11 @@ assignees: ''
--- ---
### Description ## Description
<!-- Describe what the module should accomplish: --> <!-- Describe what the module should accomplish: -->
### Notify maintainers ## Notify maintainers
<!-- If applicable, tag the maintainers of the package that corresponds to the module. If the search.nixos.org result shows no maintainers, tag the person that last updated the package. --> <!-- If applicable, tag the maintainers of the package that corresponds to the module. If the search.nixos.org result shows no maintainers, tag the person that last updated the package. -->

View File

@ -7,23 +7,30 @@ assignees: ''
--- ---
## Package Information
<!-- Search for the package here: https://search.nixos.org/packages?channel=unstable -->
- Package name: - Package name:
- Latest released version: - Latest released version:
<!-- Search your package here: https://search.nixos.org/packages?channel=unstable -->
- Current version on the unstable channel: - Current version on the unstable channel:
- Current version on the stable/release channel: - Current version on the stable/release channel:
## Checklist
<!-- <!--
Type the name of your package and try to find an open pull request for the package Type the name of your package and try to find an open pull request for the package
If you find an open pull request, you can review it! If you find an open pull request, you can review it!
There's a high chance that you'll have the new version right away while helping the community! There's a high chance that you'll have the new version right away while helping the community!
--> -->
- [ ] Checked the [nixpkgs pull requests](https://github.com/NixOS/nixpkgs/pulls) - [ ] Checked the [nixpkgs pull requests](https://github.com/NixOS/nixpkgs/pulls)
**Notify maintainers** ## Notify maintainers
<!-- If the search.nixos.org result shows no maintainers, tag the person that last updated the package. --> <!-- If the search.nixos.org result shows no maintainers, tag the person that last updated the package. -->
----- ---
Note for maintainers: Please tag this issue in your PR. Note for maintainers: Please tag this issue in your PR.

View File

@ -7,11 +7,11 @@ assignees: ''
--- ---
**Project description** ## Project description
<!-- Describe the project a little: --> <!-- Describe the project a little: -->
**Metadata** ## Metadata
* homepage URL: * homepage URL:
* source URL: * source URL:
@ -20,6 +20,10 @@ assignees: ''
--- ---
Note for maintainers: Please tag this issue in your PR.
---
Add a :+1: [reaction] to [issues you find important]. Add a :+1: [reaction] to [issues you find important].
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/

View File

@ -31,12 +31,12 @@ Fixing bit-by-bit reproducibility also has additional advantages, such as
avoiding hard-to-reproduce bugs, making content-addressed storage more effective avoiding hard-to-reproduce bugs, making content-addressed storage more effective
and reducing rebuilds in such systems. and reducing rebuilds in such systems.
### Steps To Reproduce ## Steps To Reproduce
In the following steps, replace `<package>` with the canonical name of the In the following steps, replace `<package>` with the canonical name of the
package. package.
#### 1. Build the package ### 1. Build the package
This step will build the package. Specific arguments are passed to the command This step will build the package. Specific arguments are passed to the command
to keep the build artifacts so we can compare them in case of differences. to keep the build artifacts so we can compare them in case of differences.
@ -53,7 +53,7 @@ Or using the new command line style:
nix build nixpkgs#<package> && nix build nixpkgs#<package> --rebuild --keep-failed nix build nixpkgs#<package> && nix build nixpkgs#<package> --rebuild --keep-failed
``` ```
#### 2. Compare the build artifacts ### 2. Compare the build artifacts
If the previous command completes successfully, no differences were found and If the previous command completes successfully, no differences were found and
there's nothing to do, builds are reproducible. there's nothing to do, builds are reproducible.
@ -67,7 +67,7 @@ metadata (*e.g. timestamp*) differences.
nix run nixpkgs#diffoscopeMinimal -- --exclude-directory-metadata recursive <Y> <Z> nix run nixpkgs#diffoscopeMinimal -- --exclude-directory-metadata recursive <Y> <Z>
``` ```
#### 3. Examine the build log ### 3. Examine the build log
To examine the build log, use: To examine the build log, use:
@ -81,10 +81,20 @@ Or with the new command line style:
nix log $(nix path-info --derivation nixpkgs#<package>) nix log $(nix path-info --derivation nixpkgs#<package>)
``` ```
### Additional context ## Additional context
(please share the relevant fragment of the diffoscope output here, and any (please share the relevant fragment of the diffoscope output here, and any additional analysis you may have done)
additional analysis you may have done)
## Notify maintainers
<!--
Please @ people who are in the `meta.maintainers` list of the offending package or module.
If in doubt, check `git blame` for whoever last touched something.
-->
---
Note for maintainers: Please tag this issue in your PR.
--- ---