Skip to content

Commit

Permalink
docs: add issue templates (#195)
Browse files Browse the repository at this point in the history
* docs: add issue templates

* refactor: mention show and tell
  • Loading branch information
sgoudham authored Apr 21, 2024
1 parent 69d37df commit 67e8f23
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Bug Report
description: Report your bugs with the theme here!
labels: [bug]
body:
- type: checkboxes
attributes:
label: Is there an existing issue outlining your problem?
description: Please search to see if an issue already exists for your problem.
options:
- label: I have searched the existing issues and they do not solve my problem.
required: true
- type: textarea
attributes:
label: Describe your problem.
description: Also tell us, what do you expect to see?
placeholder: The battery charging icon is missing...
validations:
required: true
- type: textarea
attributes:
label: Paste your configuration.
description: Provide us with the contents of your `.tmux.conf` file.
validations:
required: true
- type: textarea
attributes:
label: Attach screenshots.
description: If applicable, attach screenshots which clearly highlight the issue.
- type: input
attributes:
label: What tmux version are you seeing the issue on?
description: "You can find your version by running `tmux -V`"
placeholder: tmux 3.3a
validations:
required: true
- type: textarea
attributes:
label: Any additional comments?
description: Add any information that hasn't been covered in the previous sections!
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Ask A Question
url: https://github.com/catppuccin/tmux/discussions/new?category=q-a
about: Need help tweaking your Catppuccin tmux configuration? Ask questions in GitHub Discussions!
- name: Show & Tell
url: https://github.com/catppuccin/tmux/discussions/new?category=show-and-tell
about: Want to showcase your customised Catppuccin tmux configuration? Show it off in GitHub Discussions!
- name: Community Discord
url: https://discord.com/servers/catppuccin-907385605422448742
about: Chat to other community members!
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Enhancement Issue
description: Request improvements to the theme here!
labels: [enhancement]
body:
- type: checkboxes
attributes:
label: Is there an existing issue outlining your improvement?
description: Please search to see if your improvement has already been raised as an issue.
options:
- label: I have searched the existing issues and my improvement has not been raised yet.
required: true
- type: textarea
attributes:
label: What would you like to see added and/or changed?
description: Make sure to mention why you think this is an improvement!
placeholder: I'd like to have an extra configuration option for...
validations:
required: true
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/meta.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Meta Issue
description: Raise any issue regarding the repository here!
labels: [meta]
body:
- type: checkboxes
attributes:
label: Is there an existing issue outlining your problem?
description: Please search to see if an issue already exists for your problem.
options:
- label: I have searched the existing issues and they do not solve my problem.
required: true
- type: textarea
attributes:
label: Describe your issue.
description: Bugs should be raised under a [Bug Report](https://github.com/catppuccin/tmux/issues/new?assignees=&labels=bug&template=bug.yml).
placeholder: The README is missing crucial information such as...
validations:
required: true

0 comments on commit 67e8f23

Please sign in to comment.