From 20349ced5c2c23c152bbfee1665001378585eb31 Mon Sep 17 00:00:00 2001 From: Flameopathic <64027365+Flameopathic@users.noreply.github.com> Date: Mon, 24 Mar 2025 18:22:11 -0400 Subject: [PATCH] doc: add GitHub issue templates (#921) Closes: https://github.com/danth/stylix/issues/268 Link: https://github.com/danth/stylix/pull/921 Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com> Co-authored-by: awwpotato <153149335+awwpotato@users.noreply.github.com> Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug.yml | 113 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/change_option.yml | 43 +++++++++ .github/ISSUE_TEMPLATE/change_target.yml | 43 +++++++++ .github/ISSUE_TEMPLATE/new_option.yml | 43 +++++++++ .github/ISSUE_TEMPLATE/new_target.yml | 32 +++++++ 5 files changed, 274 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/change_option.yml create mode 100644 .github/ISSUE_TEMPLATE/change_target.yml create mode 100644 .github/ISSUE_TEMPLATE/new_option.yml create mode 100644 .github/ISSUE_TEMPLATE/new_target.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..2858f06d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,113 @@ +--- +description: Report a bug +labels: [bug] +name: Bug +title: ": " + +body: + - type: checkboxes + + attributes: + label: I assert that this issue is relevant for Stylix + + description: >- + If you need help or are unsure whether this is a Stylix bug, please + consider reading the [documentation](https://stylix.danth.me) or asking + for help in a [GitHub + Discussion](https://github.com/danth/stylix/discussions) or the [Stylix + Matrix Room](https://matrix.to/#/#stylix:danth.me) before opening an + issue. + + options: + - label: >- + I assert that this is a bug and not a user error or support + request. + + required: true + + - label: >- + I assert that this is not a duplicate of an [existing + issue](https://github.com/danth/stylix/issues). + + required: true + + - type: textarea + + attributes: + description: >- + Describe the issue in detail. Consider including a minimal reproducible + example, logs, or screenshots. + + label: Description + + placeholder: Type your description here… + + validations: + required: true + + - type: textarea + + attributes: + description: >- + Copy-paste the `flake.lock` file. If flakes are not used, provide the + locked input versions. + + label: flake.lock + + placeholder: |- + { + "nodes": { + }, + "root": "root", + "version": 7 + } + + render: json + + validations: + required: true + + - type: dropdown + + attributes: + description: How is Stylix installed? + label: Installation Method + + options: + - NixOS + - Home Manager + - nix-darwin + - Nix-on-Droid + - Other + + validations: + required: true + + - type: textarea + + attributes: + description: "`nix-info --markdown` output." + label: System Information + + placeholder: |- + - system: + - host os: + - multi-user?: + - sandbox: + - version: + - nixpkgs: + + validations: + required: true + + - type: textarea + + attributes: + label: Notify maintainers + + description: >- + If this bug is module-specific, consider pinging its maintainers. Each + module lists its maintainers in the + [documentation](https://stylix.danth.me). + + placeholder: "@danth, @trueNAHO" diff --git a/.github/ISSUE_TEMPLATE/change_option.yml b/.github/ISSUE_TEMPLATE/change_option.yml new file mode 100644 index 00000000..2e01fe52 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/change_option.yml @@ -0,0 +1,43 @@ +--- +description: Request a change to an existing option +labels: [change-option] +name: Change option +title: ": " + +body: + - type: checkboxes + + attributes: + label: I assert that this feature request is relevant for Stylix + + options: + - label: >- + I assert that this is not a duplicate of an [existing feature + request](https://github.com/danth/stylix/issues). + + required: true + + - type: textarea + + attributes: + label: Description + + description: >- + Describe the change and its potential breaking changes, and demonstrate + the use case it improves. + + placeholder: Type your description here… + + validations: + required: true + + - type: textarea + + attributes: + label: Notify maintainers + + description: >- + Consider pinging the module maintainers. Each module lists its + maintainers in the [documentation](https://stylix.danth.me). + + placeholder: "@danth, @trueNAHO" diff --git a/.github/ISSUE_TEMPLATE/change_target.yml b/.github/ISSUE_TEMPLATE/change_target.yml new file mode 100644 index 00000000..463076b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/change_target.yml @@ -0,0 +1,43 @@ +--- +description: Request a change to an existing target +labels: [change-target] +name: Change target +title: ": " + +body: + - type: checkboxes + + attributes: + label: I assert that this feature request is relevant for Stylix + + options: + - label: >- + I assert that this is not a duplicate of an [existing feature + request](https://github.com/danth/stylix/issues). + + required: true + + - type: textarea + + attributes: + label: Description + + description: >- + Describe the change. Consider including links to potentially useful + NixOS, Home Manager, nix-darwin, or Nix-on-Droid options. + + placeholder: Type your description here… + + validations: + required: true + + - type: textarea + + attributes: + label: Notify maintainers + + description: >- + Consider pinging the module maintainers. Each module lists its + maintainers in the [documentation](https://stylix.danth.me). + + placeholder: "@danth, @trueNAHO" diff --git a/.github/ISSUE_TEMPLATE/new_option.yml b/.github/ISSUE_TEMPLATE/new_option.yml new file mode 100644 index 00000000..43197cec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_option.yml @@ -0,0 +1,43 @@ +--- +description: Request the addition of a new option +labels: [new-option] +name: New option +title: ": add