Skip to content

Commit 16c70fd

Browse files
cainmagicainmagi
committed
0.3.0 - add issue/pr templates
Add the issue and pull request templates.
1 parent ae27a73 commit 16c70fd

File tree

7 files changed

+308
-0
lines changed

7 files changed

+308
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: Bug report
2+
description: Something is not working correctly.
3+
title: "[BUG]"
4+
labels:
5+
- bug
6+
- to be solved
7+
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Get started
12+
options:
13+
- label: >-
14+
I have read [Contributing guidelines](https://github.com/cainmagi/dash-json-grid/blob/main/CONTRIBUTING.md).
15+
required: true
16+
- label: >-
17+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/dash-json-grid/blob/main/CODE_OF_CONDUCT.md).
18+
required: true
19+
- label: >-
20+
I have confirmed that my issue is not duplicated with an existing issue.
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: Description
26+
description: >-
27+
A clear and concise description of what the bug is.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: To Reproduce
34+
description: >-
35+
Steps to reproduce the behavior. Instead of describing the steps, you could also provide your codes related to the error here.
36+
value: |
37+
1. Get package from '...'
38+
2. Then run '...'
39+
3. An error occurs.
40+
41+
- type: textarea
42+
attributes:
43+
label: Traceback
44+
description: >-
45+
The python trackback of the bug. If there is no traceback, please describe (1) The expected behaviors. (2) The actual behaviors.
46+
render: bash
47+
48+
- type: textarea
49+
attributes:
50+
label: Behaviors
51+
description: >-
52+
If there is no traceback, please describe (1) The expected behaviors. (2) The actual behaviors.
53+
value: |
54+
1. The expected behaviors:
55+
2. The actual behaviors:
56+
57+
- type: textarea
58+
attributes:
59+
label: Screenshots
60+
description: >-
61+
If applicable, add screenshots to help explain your problem.
62+
63+
- type: input
64+
attributes:
65+
label: OS
66+
description: >-
67+
e.g. Ubuntu 22.04, Debian 12, Windows 10 21H1
68+
validations:
69+
required: true
70+
- type: input
71+
attributes:
72+
label: Python version
73+
description: >-
74+
e.g. 3.12
75+
validations:
76+
required: true
77+
- type: input
78+
attributes:
79+
label: Dash JSON Grid Viewer version
80+
description: >-
81+
e.g. 0.3.0
82+
validations:
83+
required: true
84+
85+
- type: textarea
86+
attributes:
87+
label: Additional context
88+
description: >-
89+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/docs_request.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Docs request
2+
description: Report a problem or a request for the docs.
3+
title: "[Docs]"
4+
labels:
5+
- documentation
6+
- to be solved
7+
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Get started
12+
options:
13+
- label: >-
14+
I have read [Contributing guidelines](https://github.com/cainmagi/dash-json-grid/blob/main/CONTRIBUTING.md).
15+
required: true
16+
- label: >-
17+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/dash-json-grid/blob/main/CODE_OF_CONDUCT.md).
18+
required: true
19+
- label: >-
20+
I have confirmed that my issue is not duplicated with an existing issue.
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: Problem
26+
description: >-
27+
If you meet any problems with the documentation, please describe your problems here.
28+
29+
- type: textarea
30+
attributes:
31+
label: Required feature
32+
description: >-
33+
If you need more explanations in the documentation, please describe your needs here.
34+
35+
- type: input
36+
attributes:
37+
label: Dash JSON Grid Viewer version
38+
description: >-
39+
e.g. 0.3.0
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
attributes:
45+
label: Additional context
46+
description: >-
47+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature]"
4+
labels:
5+
- enhancement
6+
- to be solved
7+
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Get started
12+
options:
13+
- label: >-
14+
I have read [Contributing guidelines](https://github.com/cainmagi/dash-json-grid/blob/main/CONTRIBUTING.md).
15+
required: true
16+
- label: >-
17+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/dash-json-grid/blob/main/CODE_OF_CONDUCT.md).
18+
required: true
19+
- label: >-
20+
I have confirmed that my issue is not duplicated with an existing issue.
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: Problem
26+
description: >-
27+
If your feature request is related to a problem, please describe the problem clearly and concisely.
28+
29+
- type: textarea
30+
attributes:
31+
label: Required feature
32+
description: >-
33+
A clear and concise description of what you want to happen.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
attributes:
39+
label: Alternative solution
40+
description: >-
41+
A clear and concise description of any alternative solutions or features you've considered.
42+
43+
- type: input
44+
attributes:
45+
label: Dash JSON Grid Viewer version
46+
description: >-
47+
e.g. 0.3.0
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
attributes:
53+
label: Additional context
54+
description: >-
55+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Pull request
2+
3+
## Get started
4+
5+
- [ ] I have read [Contributing guidelines](https://github.com/cainmagi/dash-json-grid/blob/main/CONTRIBUTING.md).
6+
- [ ] I agree to follow the [Code of Conduct](https://github.com/cainmagi/dash-json-grid/blob/main/CODE_OF_CONDUCT.md).
7+
- [ ] I have confirmed that my pull request (PR) is not duplicated with an existing PR.
8+
- [ ] I have confirmed that my pull request (PR) passes the testing workflow of the project.
9+
10+
## Description
11+
12+
Describe what you have done with this PR. List any dependencies that are required for this change.
13+
14+
If your PR is designed for an issue, please refer to the issue by the following example:
15+
16+
Fixes # (issue)
17+
18+
## Updated report
19+
20+
Please summarize your modifications as an itemized report.
21+
22+
1. Update ...
23+
2. Add ...
24+
25+
## Information
26+
27+
Please provide the following information about your PR:
28+
29+
- Dash JSON Grid Viewer version:
30+
31+
## Additional context
32+
33+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Pull request
2+
3+
## Get started
4+
5+
- [ ] I have read [Contributing guidelines](https://github.com/cainmagi/dash-json-grid/blob/main/CONTRIBUTING.md).
6+
- [ ] I agree to follow the [Code of Conduct](https://github.com/cainmagi/dash-json-grid/blob/main/CODE_OF_CONDUCT.md).
7+
- [ ] I have confirmed that my pull request (PR) is not duplicated with an existing PR.
8+
- [ ] I have confirmed that my pull request (PR) passes the testing workflow of the project.
9+
10+
## Description
11+
12+
Describe what you have done with this PR. List any dependencies that are required for this change.
13+
14+
If your PR is designed for an issue, please refer to the issue by the following example:
15+
16+
Fixes # (issue)
17+
18+
## Updated report
19+
20+
Please summarize your modifications as an itemized report.
21+
22+
1. Update ...
23+
2. Add ...
24+
25+
## Information
26+
27+
Please provide the following information about your PR:
28+
29+
- Dash JSON Grid Viewer version:
30+
31+
## Additional context
32+
33+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Pull request
2+
description: Send a pull request (PR) for this project.
3+
title: "[PR]"
4+
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Get started
9+
options:
10+
- label: >-
11+
I have read [Contributing guidelines](https://github.com/cainmagi/dash-json-grid/blob/main/CONTRIBUTING.md).
12+
required: true
13+
- label: >-
14+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/dash-json-grid/blob/main/CODE_OF_CONDUCT.md).
15+
required: true
16+
- label: >-
17+
I have confirmed that my pull request (PR) is not duplicated with an existing PR.
18+
required: true
19+
- label: >-
20+
I have confirmed that my pull request (PR) passes the testing workflow of the project.
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: Description
26+
description: >-
27+
Describe what you have done with this PR.
28+
29+
- type: textarea
30+
attributes:
31+
label: Updated report
32+
description: >-
33+
Summarize your modifications as itemized report.
34+
value: |
35+
1. Update ...
36+
2. Add ...
37+
38+
- type: input
39+
attributes:
40+
label: Dash JSON Grid Viewer version
41+
description: >-
42+
e.g. 0.3.0
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Additional context
49+
description: >-
50+
Add any other context about the problem here.

‎Changelog.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
7. Configure the python test workflow.
2121
8. Upload the .lock file because it is required by the workflow.
2222
9. Configure the python package uploading workflow.
23+
10. Add the issue and pull request templates.
2324

2425
#### :wrench: Fix
2526

0 commit comments

Comments
 (0)