Skip to content

Commit

Permalink
chore: update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Aug 2, 2024
1 parent 3533ac2 commit 3fdbbfe
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 21 deletions.
22 changes: 4 additions & 18 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Bug Report
name: 🐞 Bug Report
description: Create a report to help us improve
labels: [bug]
assignees: []
Expand Down Expand Up @@ -59,28 +59,14 @@ body:
validations:
required: true
- type: textarea
id: expected
id: reproducer
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen
validations:
required: true
- type: textarea
id: to_repro
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
label: Minimal reproducer
description: A [minimal reproducer](https://stackoverflow.com/help/minimal-reproducible-example) is required, otherwise the issue might be closed without further notice.
placeholder: |
Please include as much information as possible that can help to reproduce and understand the issue.
validations:
required: true
- type: textarea
id: config
attributes:
label: Configuration
description: |
Please include the relevant section(s) of your `yazi.toml`, `keymap.toml`, or `theme.toml` configuration file.
You can enter "no config" if the issue happens without you having made a config file.
- type: textarea
id: other
attributes:
Expand Down
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Discord server / Telegram group
- name: 📝 Documentation Improvement
url: https://github.com/yazi-rs/yazi-rs.github.io
about: If you'd like to help improve the documentation
- name: 🌐 Discord Server / Telegram Group
url: https://github.com/sxyazi/yazi#discussion
about: If you'd prefer more realtime conversation with the community
- name: GitHub Discussions
- name: 💬 GitHub Discussions
url: https://github.com/sxyazi/yazi/discussions
about: When you have questions that are not bug reports or feature requests
29 changes: 28 additions & 1 deletion .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
name: Feature Request
name: 💡 Feature Request
description: Suggest an idea for this project
labels: [feature]
assignees: []
body:
- type: textarea
id: debug
attributes:
label: "`yazi --debug` output"
description: Please run `yazi --debug` and paste the debug information here.
value: |
<details>
```sh
##### ↓↓↓ Paste the output here: ↓↓↓ #####
```
</details>
validations:
required: true
- type: textarea
id: problem
attributes:
Expand All @@ -29,3 +46,13 @@ body:
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
- type: checkboxes
id: validations
attributes:
label: Validations
description: Before submitting the issue, please make sure you have completed the following
options:
- label: I have searched the existing issues
required: true
- label: The latest nightly build of Yazi doesn't already have this feature
required: true

0 comments on commit 3fdbbfe

Please sign in to comment.