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>
This commit is contained in:
Flameopathic
GitHub
parent
d9df91c556
commit
20349ced5c
5 changed files with 274 additions and 0 deletions
113
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
113
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
---
|
||||
description: Report a bug
|
||||
labels: [bug]
|
||||
name: Bug
|
||||
title: "<SCOPE>: <SUMMARY>"
|
||||
|
||||
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"
|
||||
43
.github/ISSUE_TEMPLATE/change_option.yml
vendored
Normal file
43
.github/ISSUE_TEMPLATE/change_option.yml
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
description: Request a change to an existing option
|
||||
labels: [change-option]
|
||||
name: Change option
|
||||
title: "<SCOPE>: <DESCRIPTION>"
|
||||
|
||||
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"
|
||||
43
.github/ISSUE_TEMPLATE/change_target.yml
vendored
Normal file
43
.github/ISSUE_TEMPLATE/change_target.yml
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
description: Request a change to an existing target
|
||||
labels: [change-target]
|
||||
name: Change target
|
||||
title: "<TARGET>: <DESCRIPTION>"
|
||||
|
||||
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"
|
||||
43
.github/ISSUE_TEMPLATE/new_option.yml
vendored
Normal file
43
.github/ISSUE_TEMPLATE/new_option.yml
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
description: Request the addition of a new option
|
||||
labels: [new-option]
|
||||
name: New option
|
||||
title: "<SCOPE>: add <OPTION> option"
|
||||
|
||||
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 option and explain its use case. Consider including
|
||||
pseudocode demonstrating its integration with the existing architecture.
|
||||
|
||||
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"
|
||||
32
.github/ISSUE_TEMPLATE/new_target.yml
vendored
Normal file
32
.github/ISSUE_TEMPLATE/new_target.yml
vendored
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
description: Request the addition of a new target
|
||||
labels: [new-target]
|
||||
name: New target
|
||||
title: "<TARGET>: add target"
|
||||
|
||||
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 feature. Consider including links to existing themes, like
|
||||
a [tinted-theming repository](https://github.com/tinted-theming).
|
||||
|
||||
placeholder: Type your description here…
|
||||
|
||||
validations:
|
||||
required: true
|
||||
Loading…
Add table
Add a link
Reference in a new issue