Unverified Commit 0375ee86 authored by Fernando Rodrigues's avatar Fernando Rodrigues
Browse files

ISSUE_TEMPLATE: convert the feature requests (package, module, update,... 


ISSUE_TEMPLATE: convert the feature requests (package, module, update, backport requests) into YAML forms

The out of date package report was split into two forms: an update request and a backport request.

Signed-off-by: default avatarFernando Rodrigues <alpha@sigmasquadron.net>
parent 76881db8

.github/ISSUE_TEMPLATE/05_package_request.yml

0 → 100644
+127 −0
Original line number Diff line number Diff line 
name: "Request: new package"

description: "Create a package request for software that is not yet included in Nixpkgs."

title: "Package request: PACKAGENAME"

labels: ["0.kind: enhancement", "0.kind: packaging request", "9.needs: package (new)"]

body:

  - type: "markdown"

    attributes:

      value: |

        <p align="center">

          <a href="https://nixos.org">

            <picture>

              <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png">

              <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NixOS/nixos-artwork/master/logo/nixos-white.png">

              <img src="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png" width="400px" alt="NixOS logo">

            </picture>

          </a>

        </p>



        Welcome to Nixpkgs. Please replace the **`Package request: PACKAGENAME`** template above with the correct package name (As seen in the [NixOS Package Search](https://search.nixos.org/packages)).



        > [!TIP]

        > For instance, if you were filing a request against the missing `hello` package, your title would be as follows:

        > `Package request: hello`



        ---

  - type: "dropdown"

    id: "version"

    attributes:

      label: "Nixpkgs version"

      description: |

        What version of Nixpkgs are you using?



        > [!IMPORTANT]

        > If you are using an older or stable version, please update to the latest **unstable** version and check if the package still does not exist before continuing this request.

      options:

        - "Please select a version."

        - "- Unstable (25.05)"

        - "- Stable (24.11)"

        - "- Previous Stable (24.05)"

      default: 0

    validations:

      required: true

  - type: "textarea"

    id: "description"

    attributes:

      label: "Describe the package"

      description: "Please include a clear and concise description of what the package is."

    validations:

      required: true

  - type: "input"

    id: "homepage"

    attributes:

      label: "Upstream homepage"

      description: "Please copy and paste a link to the package's homepage. Leave this field blank if there is no upstream homepage."

    validations:

      required: false

  - type: "input"

    id: "source"

    attributes:

      label: "Source URL"

      description: "Please copy and paste a link to the package's source code or binary download page."

    validations:

      required: true

  - type: "input"

    id: "license"

    attributes:

      label: "License"

      description: "Please indicate the package's license. If the package has no license, or the source code is not public, please indicate the package is `unfree`."

    validations:

      required: true

  - type: "dropdown"

    id: "platforms"

    attributes:

      label: "Platforms"

      description: "Please indicate the platforms this package compiles for. `darwin` refers to macOS. `Exotic` refers to uncommon platforms like RISC-V or 32-bit ARM; please mention in the 'Additional Context' section below if this package is supposed to compile for such exotic platforms."

      multiple: true

      options:

        - "x86_64-linux"

        - "aarch64-linux"

        - "x86_64-darwin"

        - "aarch64-darwin"

        - "Exotic"

    validations:

      required: true

  - type: "textarea"

    id: "additional-context"

    attributes:

      label: "Additional context"

      description: "Add any other context about the proposed module here."

    validations:

      required: false

  - type: "checkboxes"

    id: "sanity-check"

    attributes:

      label: "I assert that this issue is relevant for Nixpkgs"

      options:

        - label: "I assert that this package does not yet exist in an [open pull request](https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+package+%28new%29%22) or in [Nixpkgs Unstable](https://search.nixos.org/packages?channel=unstable)."

          required: true

        - label: "I assert that this is not a [duplicate of any known issue](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+label%3A%220.kind%3A+packaging+request%22)."

          required: true

        - label: "I assert that I have read the [NixOS Code of Conduct](https://github.com/NixOS/.github/blob/master/CODE_OF_CONDUCT.md) and agree to abide by it."

          required: true

  - type: "markdown"

    attributes:

      value: |

        # Thank you for helping improve Nixpkgs!



        ---

  - type: "textarea"

    id: "prioritisation"

    attributes:

      label: "For this package's maintainers:"

      description: |

        **Please do not modify this text area!**



        This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction and also reminds them to tag this issue in their pull requests.

        This is not a guarantee that highly-requested issues will be fixed first, but it helps us to figure out what's important to users. Please react on other users' issues if you find them important.

      value: |



        Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)



        ---



        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

.github/ISSUE_TEMPLATE/06_update_request.yml

0 → 100644
+120 −0
Original line number Diff line number Diff line 
name: "Request: package update"

description: "Create an update request for an existing, but outdated package."

title: "Update Request: PACKAGENAME OLDVERSION → NEWVERSION"

labels: ["0.kind: enhancement", "9.needs: package (update)"]

body:

  - type: "markdown"

    attributes:

      value: |

        <p align="center">

          <a href="https://nixos.org">

            <picture>

              <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png">

              <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NixOS/nixos-artwork/master/logo/nixos-white.png">

              <img src="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png" width="400px" alt="NixOS logo">

            </picture>

          </a>

        </p>



        Welcome to Nixpkgs. Please replace the **`Update Request: PACKAGENAME OLDVERSION → NEWVERSION`** template above with the correct package name (As seen in the [NixOS Package Search](https://search.nixos.org/packages)), the current version of the package, and the latest version of the package.



        > [!TIP]

        > For instance, if you were filing a request against the out of date `hello` package, where the current version in Nixpkgs is 1.0.0, but the latest version upstream is 1.0.1, your title would be as follows:

        > `Update Request: hello 1.0.0 → 1.0.1`



        > [!NOTE]

        > If you are filing an update request to change a package's source to a fork, please file a new package request instead. Even if the original upstream is outdated, the fork should be considered a new package.



        ---

  - type: "dropdown"

    id: "version"

    attributes:

      label: "Nixpkgs version"

      description: |

        What version of Nixpkgs are you using?



        > [!IMPORTANT]

        > If you are using an older or stable version, please update to the latest **unstable** version and check if the package is still out of date.

        > If the package has been updated in unstable, but you believe the update should be backported to the stable release of Nixpkgs, please file the '**Request: backport to stable**' form instead.

      options:

        - "Please select a version."

        - "- Unstable (25.05)"

        - "- Stable (24.11)"

        - "- Previous Stable (24.05)"

      default: 0

    validations:

      required: true

  - type: "input"

    id: "name"

    attributes:

      label: "Package name"

      description: "Please indicate the name of the package."

    validations:

      required: true

  - type: "input"

    id: "upstream-version"

    attributes:

      label: "Upstream version"

      description: "Please indicate the latest version of the package."

    validations:

      required: true

  - type: "input"

    id: "nixpkgs-version"

    attributes:

      label: "Nixpkgs version"

      description: |

        Please indicate the current version number in Nixpkgs' **unstable** channel. You can check this by setting the [NixOS Package Search](https://search.nixos.org/packages?channel=unstable) channel to 'unstable' and searching for the package.

        If you meant to request an upgrade in the stable channel, please file the '**Request: backport to stable**' form instead.

    validations:

      required: true

  - type: "input"

    id: "changelog"

    attributes:

      label: "Changelog"

      description: "If applicable, please link the upstream changelog for the latest version."

    validations:

      required: false

  - type: "textarea"

    id: "maintainers"

    attributes:

      label: "Notify maintainers"

      description: |

        Please mention the people who are in the **Maintainers** list of the offending package. This is done by by searching for the package on the [NixOS Package Search](https://search.nixos.org/packages) and mentioning the people listed under **Maintainers** by prefixing their GitHub usernames with an '@' character. Please add the mentions above the `---` characters in the template below.

      value: |



        ---



        **Note for maintainers:** Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)

    validations:

      required: false

  - type: "checkboxes"

    id: "sanity-check"

    attributes:

      label: "I assert that this issue is relevant for Nixpkgs"

      options:

        - label: "I assert that this package update does not yet exist in an [open pull request](https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+package+%28update%29%22) or in [Nixpkgs Unstable](https://search.nixos.org/packages?channel=unstable)."

          required: true

        - label: "I assert that this is not a [duplicate of any known issue](https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%229.needs%3A+package+%28update%29%22)."

          required: true

        - label: "I assert that I have read the [NixOS Code of Conduct](https://github.com/NixOS/.github/blob/master/CODE_OF_CONDUCT.md) and agree to abide by it."

          required: true

  - type: "markdown"

    attributes:

      value: |

        # Thank you for helping improve Nixpkgs!



        ---

  - type: "textarea"

    id: "prioritisation"

    attributes:

      label: "Is this issue important to you?"

      description: |

        **Please do not modify this text area!**



        This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction.

        This is not a guarantee that highly-requested issues will be fixed first, but it helps us to figure out what's important to users. Please react on other users' issues if you find them important.

      value: |

        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

.github/ISSUE_TEMPLATE/07_module_request.yml

0 → 100644
+100 −0
Original line number Diff line number Diff line 
name: "Request: NixOS module"

description: "Create a new NixOS Module request for an existing package."

title: "Module Request: nixos/MODULENAME"

labels: ["0.kind: enhancement", "6.topic: nixos", "9.needs: module (new)"]

body:

  - type: "markdown"

    attributes:

      value: |

        <p align="center">

          <a href="https://nixos.org">

            <picture>

              <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png">

              <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NixOS/nixos-artwork/master/logo/nixos-white.png">

              <img src="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png" width="400px" alt="NixOS logo">

            </picture>

          </a>

        </p>



        Welcome to Nixpkgs. Please replace the **`Module Request: nixos/MODULENAME`** template above with the correct module name (As seen in the [NixOS Option Search](https://search.nixos.org/options)).



        > [!TIP]

        > For instance, if you were filing a request against the missing `hello` module, your title would be as follows:

        > `Module Request: nixos/hello`



        ---

  - type: "dropdown"

    id: "version"

    attributes:

      label: "Nixpkgs version"

      description: |

        What version of Nixpkgs are you using?



        > [!IMPORTANT]

        > If you are using an older or stable version, please update to the latest **unstable** version and check if the module still does not exist before continuing this request.

      options:

        - "Please select a version."

        - "- Unstable (25.05)"

        - "- Stable (24.11)"

        - "- Previous Stable (24.05)"

      default: 0

    validations:

      required: true

  - type: "textarea"

    id: "description"

    attributes:

      label: "Describe the proposed module"

      description: "Please include a clear and concise description of what the module should accomplish."

    validations:

      required: true

  - type: "textarea"

    id: "additional-context"

    attributes:

      label: "Additional context"

      description: "Add any other context about the proposed module here."

    validations:

      required: false

  - type: "textarea"

    id: "maintainers"

    attributes:

      label: "Notify maintainers"

      description: |

        Please mention the people who are in the **Maintainers** list of the offending package. This is done by by searching for the package on the [NixOS Package Search](https://search.nixos.org/packages) and mentioning the people listed under **Maintainers** by prefixing their GitHub usernames with an '@' character. Please add the mentions above the `---` characters in the template below.

      value: |



        ---



        **Note for maintainers:** Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)

    validations:

      required: false

  - type: "checkboxes"

    id: "sanity-check"

    attributes:

      label: "I assert that this issue is relevant for Nixpkgs"

      options:

        - label: "I assert that this module does not yet exist in an [open pull request](https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+module+%28new%29%22) or in [NixOS Unstable](https://search.nixos.org/options?channel=unstable)."

          required: true

        - label: "I assert that this is not a [duplicate of an existing issue](https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%229.needs%3A+module+%28new%29%22). "

          required: true

        - label: "I assert that I have read the [NixOS Code of Conduct](https://github.com/NixOS/.github/blob/master/CODE_OF_CONDUCT.md) and agree to abide by it."

          required: true

  - type: "markdown"

    attributes:

      value: |

        # Thank you for helping improve NixOS!



        ---

  - type: "textarea"

    id: "prioritisation"

    attributes:

      label: "Is this issue important to you?"

      description: |

        **Please do not modify this text area!**



        This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction.

        This is not a guarantee that highly-requested issues will be fixed first, but it helps us to figure out what's important to users. Please react on other users' issues if you find them important.

      value: |

        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

.github/ISSUE_TEMPLATE/08_backport_request.yml

0 → 100644
+102 −0
Original line number Diff line number Diff line 
name: "Request: backport to stable"

description: "Create a backport request for a package that is up-to-date in the unstable channel, but outdated in the stable channel."

title: "Backport to Stable: PACKAGENAME OLDVERSION → NEWVERSION"

labels: ["0.kind: enhancement", "9.needs: port to stable"]

body:

  - type: "markdown"

    attributes:

      value: |

        <p align="center">

          <a href="https://nixos.org">

            <picture>

              <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png">

              <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NixOS/nixos-artwork/master/logo/nixos-white.png">

              <img src="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png" width="400px" alt="NixOS logo">

            </picture>

          </a>

        </p>



        > [!CAUTION]

        > **Before you begin:** Be advised that backports are subject to the [release suitability guidelines](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#changes-acceptable-for-releases).

        > Stable releases of Nixpkgs do not receive breaking changes, which include major package updates that have incompatible API changes and break backwards compatibility. In the [Semantic Versioning standard](https://semver.org/), this is the first version number. (1.X.X)

        > Generally, only minor package updates, such as security patches, bug fixes and feature additions (but not removals!) will be considered for backporting. Please read the rules above carefully before filing this backport request.



        Welcome to Nixpkgs. Please replace the **`Backport to Stable: PACKAGENAME OLDVERSION → NEWVERSION`** template above with the correct package name (As seen in the [NixOS Package Search](https://search.nixos.org/packages)), the current version of the package in Nixpkgs Stable and the current version of the package in Nixpkgs Unstable.



        > [!TIP]

        > For instance, if you were filing a request against the out of date `hello` package, where the current version in Nixpkgs Unstable is 1.0.1, but the current version in Nixpkgs Stable is 1.0.0, your title would be as follows:

        > `Backport to Stable: hello 1.0.0 → 1.0.1`



        ---

  - type: "input"

    id: "name"

    attributes:

      label: "Package name"

      description: "Please indicate the name of the package."

    validations:

      required: true

  - type: "input"

    id: "unstable-version"

    attributes:

      label: "Version in unstable"

      description: "Please indicate the current version of the package in the unstable channel."

    validations:

      required: true

  - type: "input"

    id: "stable-version"

    attributes:

      label: "Version in stable"

      description: "Please indicate the current version of the package in the stable channel."

    validations:

      required: true

  - type: "textarea"

    id: "reasoning"

    attributes:

      label: "Reasoning for backport"

      description: "Please briefly explain why this backport fits the [release suitability guidelines](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#changes-acceptable-for-releases) and why you think this update should be backported."

    validations:

      required: false

  - type: "textarea"

    id: "maintainers"

    attributes:

      label: "Notify maintainers"

      description: |

        Please mention the people who are in the **Maintainers** list of the offending package. This is done by by searching for the package on the [NixOS Package Search](https://search.nixos.org/packages) and mentioning the people listed under **Maintainers** by prefixing their GitHub usernames with an '@' character. Please add the mentions above the `---` characters in the template below.

      value: |



        ---



        **Note for maintainers:** Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)

    validations:

      required: false

  - type: "checkboxes"

    id: "sanity-check"

    attributes:

      label: "I assert that this issue is relevant for Nixpkgs"

      options:

        - label: "I assert that this backport does not yet exist in an [open pull request](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+in%3Atitle+backport)."

          required: true

        - label: "I assert that this is not a [duplicate of any known issue](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+label%3A%229.needs%3A+port+to+stable%22+)."

          required: true

        - label: "I assert that I have read the [NixOS Code of Conduct](https://github.com/NixOS/.github/blob/master/CODE_OF_CONDUCT.md) and agree to abide by it."

          required: true

  - type: "markdown"

    attributes:

      value: |

        # Thank you for helping improve Nixpkgs!



        ---

  - type: "textarea"

    id: "prioritisation"

    attributes:

      label: "Is this issue important to you?"

      description: |

        **Please do not modify this text area!**



        This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction.

        This is not a guarantee that highly-requested issues will be fixed first, but it helps us to figure out what's important to users. Please react on other users' issues if you find them important.

      value: |

        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

.github/ISSUE_TEMPLATE/module_request.md

deleted100644 → 0
+0 −27
Original line number Diff line number Diff line 
---

name: Module requests

about: For NixOS modules that you would like to see

title: 'Module request: MODULENAME'

labels: '9.needs: module (new)'

assignees: ''



---



## Description



<!-- Describe what the module should accomplish: -->



## 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. -->



-----



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/

[issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc