Skip to content

Commit 71690f8

Browse files
committed
chore: update issue templates
1 parent 3533ac2 commit 71690f8

File tree

3 files changed

+37
-21
lines changed

3 files changed

+37
-21
lines changed

.github/ISSUE_TEMPLATE/bug.yml

+4-18
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Bug Report
1+
name: 🐞 Bug Report
22
description: Create a report to help us improve
33
labels: [bug]
44
assignees: []
@@ -59,28 +59,14 @@ body:
5959
validations:
6060
required: true
6161
- type: textarea
62-
id: expected
62+
id: reproducer
6363
attributes:
64-
label: Expected Behavior
65-
description: A clear and concise description of what you expected to happen
66-
validations:
67-
required: true
68-
- type: textarea
69-
id: to_repro
70-
attributes:
71-
label: To Reproduce
72-
description: Steps to reproduce the behavior
64+
label: Minimal reproducer
65+
description: A [minimal reproducer](https://stackoverflow.com/help/minimal-reproducible-example) is required, otherwise the issue might be closed without further notice.
7366
placeholder: |
7467
Please include as much information as possible that can help to reproduce and understand the issue.
7568
validations:
7669
required: true
77-
- type: textarea
78-
id: config
79-
attributes:
80-
label: Configuration
81-
description: |
82-
Please include the relevant section(s) of your `yazi.toml`, `keymap.toml`, or `theme.toml` configuration file.
83-
You can enter "no config" if the issue happens without you having made a config file.
8470
- type: textarea
8571
id: other
8672
attributes:

.github/ISSUE_TEMPLATE/config.yml

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Discord server / Telegram group
3+
- name: 📝 Documentation improvement
4+
url: https://github.com/yazi-rs/yazi-rs.github.io
5+
about: If you'd like to help improve the documentation
6+
- name: 🌐 Discord server / Telegram group
47
url: https://github.com/sxyazi/yazi#discussion
58
about: If you'd prefer more realtime conversation with the community
6-
- name: GitHub Discussions
9+
- name: 💬 GitHub Discussions
710
url: https://github.com/sxyazi/yazi/discussions
811
about: When you have questions that are not bug reports or feature requests

.github/ISSUE_TEMPLATE/feature.yml

+28-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Feature Request
1+
name: 💡 Feature Request
22
description: Suggest an idea for this project
33
labels: [feature]
44
assignees: []
@@ -10,6 +10,23 @@ body:
1010
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1111
validations:
1212
required: true
13+
- type: textarea
14+
id: debug
15+
attributes:
16+
label: "`yazi --debug` output"
17+
description: Please run `yazi --debug` and paste the debug information here.
18+
value: |
19+
<details>
20+
21+
```sh
22+
##### ↓↓↓ Paste the output here: ↓↓↓ #####
23+
24+
25+
```
26+
27+
</details>
28+
validations:
29+
required: true
1330
- type: checkboxes
1431
id: contribute
1532
attributes:
@@ -29,3 +46,13 @@ body:
2946
attributes:
3047
label: Additional context
3148
description: Add any other context or screenshots about the feature request here.
49+
- type: checkboxes
50+
id: validations
51+
attributes:
52+
label: Validations
53+
description: Before submitting the issue, please make sure you have completed the following
54+
options:
55+
- label: I have searched the existing issues
56+
required: true
57+
- label: The latest nightly build of Yazi doesn't already have this feature
58+
required: true

0 commit comments

Comments
 (0)