From d385091084625390437a159ae31746be35f80553 Mon Sep 17 00:00:00 2001
From: Gavin John <gavinnjohn@gmail.com>
Date: Sat, 9 Nov 2024 01:17:56 -0800
Subject: [PATCH] .github: Use consistent (and correct) formatting across issue
 templates

---
 .github/ISSUE_TEMPLATE/bug_report.md          | 34 ++++++++++++-------
 .github/ISSUE_TEMPLATE/build_failure.md       | 28 ++++++++++-----
 .../ISSUE_TEMPLATE/missing_documentation.md   | 15 ++++----
 .github/ISSUE_TEMPLATE/module_request.md      |  4 +--
 .../out_of_date_package_report.md             | 13 +++++--
 .github/ISSUE_TEMPLATE/packaging_request.md   |  8 +++--
 .../ISSUE_TEMPLATE/unreproducible_package.md  | 24 +++++++++----
 7 files changed, 86 insertions(+), 40 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dd9e22e9a689..a4b757e9b4f4 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,34 +7,44 @@ assignees: ''
 
 ---
 
-### Describe the bug
-A clear and concise description of what the bug is.
+## Describe the bug
+
+<!-- A clear and concise description of what the bug is. -->
+
+## Steps To Reproduce
 
-### Steps To Reproduce
 Steps to reproduce the behavior:
+
 1. ...
 2. ...
 3. ...
 
-### Expected behavior
-A clear and concise description of what you expected to happen.
+## Expected behavior
 
-### Screenshots
-If applicable, add screenshots to help explain your problem.
+<!-- A clear and concise description of what you expected to happen. -->
 
-### Additional context
-Add any other context about the problem here.
+## Screenshots
 
-### 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.
 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.
 
 ---
 
diff --git a/.github/ISSUE_TEMPLATE/build_failure.md b/.github/ISSUE_TEMPLATE/build_failure.md
index 5e6c300b56d3..6df42832765b 100644
--- a/.github/ISSUE_TEMPLATE/build_failure.md
+++ b/.github/ISSUE_TEMPLATE/build_failure.md
@@ -7,31 +7,43 @@ assignees: ''
 
 ---
 
-### Steps To Reproduce
+## Steps To Reproduce
 
 Steps to reproduce the behavior:
+
 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.
 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.
 
 ---
 
diff --git a/.github/ISSUE_TEMPLATE/missing_documentation.md b/.github/ISSUE_TEMPLATE/missing_documentation.md
index 6f8e583bd346..a7f0fd83c5bc 100644
--- a/.github/ISSUE_TEMPLATE/missing_documentation.md
+++ b/.github/ISSUE_TEMPLATE/missing_documentation.md
@@ -23,12 +23,9 @@ assignees: ''
 - [ ] checked [open documentation issues] for possible duplicates
 - [ ] 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
-[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
+---
+
+Note for maintainers: Please tag this issue in your PR.
 
 ---
 
@@ -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/
 [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
diff --git a/.github/ISSUE_TEMPLATE/module_request.md b/.github/ISSUE_TEMPLATE/module_request.md
index db0b68cfe453..752011fb5449 100644
--- a/.github/ISSUE_TEMPLATE/module_request.md
+++ b/.github/ISSUE_TEMPLATE/module_request.md
@@ -7,11 +7,11 @@ assignees: ''
 
 ---
 
-### Description
+## Description
 
 <!-- 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. -->
 
diff --git a/.github/ISSUE_TEMPLATE/out_of_date_package_report.md b/.github/ISSUE_TEMPLATE/out_of_date_package_report.md
index 802f47935aee..da42c82ca4ea 100644
--- a/.github/ISSUE_TEMPLATE/out_of_date_package_report.md
+++ b/.github/ISSUE_TEMPLATE/out_of_date_package_report.md
@@ -7,23 +7,30 @@ assignees: ''
 
 ---
 
+## Package Information
+
+<!-- Search for the package here: https://search.nixos.org/packages?channel=unstable -->
+
 - Package name:
 - Latest released version:
-<!-- Search your package here: https://search.nixos.org/packages?channel=unstable -->
 - Current version on the unstable 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
 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!
 -->
+
 - [ ] 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. -->
 
------
+---
 
 Note for maintainers: Please tag this issue in your PR.
 
diff --git a/.github/ISSUE_TEMPLATE/packaging_request.md b/.github/ISSUE_TEMPLATE/packaging_request.md
index 021c9060ebe5..91175402bed3 100644
--- a/.github/ISSUE_TEMPLATE/packaging_request.md
+++ b/.github/ISSUE_TEMPLATE/packaging_request.md
@@ -7,11 +7,11 @@ assignees: ''
 
 ---
 
-**Project description**
+## Project description
 
 <!-- Describe the project a little: -->
 
-**Metadata**
+## Metadata
 
 * homepage 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].
 
 [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
diff --git a/.github/ISSUE_TEMPLATE/unreproducible_package.md b/.github/ISSUE_TEMPLATE/unreproducible_package.md
index dd19abaf7588..83b672be31b3 100644
--- a/.github/ISSUE_TEMPLATE/unreproducible_package.md
+++ b/.github/ISSUE_TEMPLATE/unreproducible_package.md
@@ -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
 and reducing rebuilds in such systems.
 
-### Steps To Reproduce
+## Steps To Reproduce
 
 In the following steps, replace `<package>` with the canonical name of the
 package.
 
-#### 1. Build the package
+### 1. Build the package
 
 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.
@@ -53,7 +53,7 @@ Or using the new command line style:
 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
 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>
 ```
 
-#### 3. Examine the build log
+### 3. Examine the build log
 
 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>)
 ```
 
-### Additional context
+## Additional context
 
-(please share the relevant fragment of the diffoscope output here, and any
-additional analysis you may have done)
+(please share the relevant fragment of the diffoscope output here, and any 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.
 
 ---