Skip to content

Commit 52d24ce

Browse files
committed
package: add new GitHub issue templates
1 parent 7eed221 commit 52d24ce

File tree

6 files changed

+99
-27
lines changed

6 files changed

+99
-27
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-27
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 'Bug report'
2+
description: Report a bug in this project.
3+
labels: ['bug']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before creating an issue, please read the following:
9+
10+
- Read the `README.md` file on the project page or the documentation file and compare your code to the intent of the project.
11+
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
12+
- Please create a separate issue for each type of issue.
13+
- For modular projects, make sure you're using the latest version of the module.
14+
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
15+
- type: textarea
16+
attributes:
17+
label: Describe the bug
18+
description: |
19+
For the issue you are experiencing, please describe in detail what you are seeing, the error message, and the impact of the issue. If you are able to reproduce the issue, please list the steps in order. You can attach an image or video if necessary.
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Expected behavior
25+
description: Describe how it should be handled when it's normal behavior or what needs to be fixed.
26+
validations:
27+
- type: input
28+
attributes:
29+
label: Your environment - System OS
30+
description: Please describe the full range of OSes you are experiencing the issue with, preferably including the version.
31+
placeholder: Windows 11, macOS 15.x, Linux Ubuntu 24.04, Android 15, iOS 16...
32+
validations:
33+
- type: input
34+
attributes:
35+
label: Your environment - Web Browser
36+
description: If relevant, please describe the web browser you are currently using.
37+
placeholder: Google Chrome, Microsoft Edge, Mozilla Firefox...
38+
validations:

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 'Feature request'
2+
description: Report a feature request in this project.
3+
labels: ['enhancement']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before creating an issue, please read the following:
9+
10+
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
11+
- Please create a separate issue for each type of issue.
12+
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
13+
- type: textarea
14+
attributes:
15+
label: Describe the feature
16+
description: Feel free to describe any features or improvements you would like to see. You can attach text or images of examples, behavior, etc. from other projects to elaborate.
17+
validations:
18+
required: true

.github/ISSUE_TEMPLATE/fix_typo.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 'Fix typo request'
2+
description: Request to fix a typo or bad translation in this project
3+
labels: ['typo']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before creating an issue, please read the following:
9+
10+
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
11+
- Please create a separate issue for each type of issue.
12+
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
13+
- type: textarea
14+
attributes:
15+
label: Describe the issue
16+
description: Please describe where the typo occurs and a list of text that needs to be corrected.
17+
validations:
18+
required: true

.github/pull_request_template.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thank you for contributing to the project. Your contribution will be reviewed and approved after appropriate review.
3+
4+
Please read the caveats below to ensure a fast merge.
5+
-->
6+
7+
## Pull request checklist
8+
9+
You should familiarize yourself with the files `README.md`, `CONTRIBUTING.md`, and `CODE_OF_CONDUCT.md` in the root of your project.
10+
11+
- If an issue has been created for this, add `(fixes #{ISSUE_NUMBER})` to the end of the commit description. In `{ISSUE_NUMBER}`, please include the relevant issue number.
12+
- If you need to update or add to the article, please update the relevant content. If a multilingual article exists, you should update all relevant content in your own language, except for translations.
13+
- Add or update test code if it exists and is needed. Also, verify that the tests pass.
14+
- If this PR is not yet complete, keep the PR in draft status. If it's no longer valid, close the PR with an explanation.
15+
16+
<!--
17+
Below is a template for describing this PR. It's not required, so please delete the content below if you don't need it.
18+
-->
19+
20+
### What did you change?
21+
22+
### Why did you make the change?
23+
24+
### How does this work?

0 commit comments

Comments
 (0)