Skip to content

Commit ae326f6

Browse files
eyllanescLee-W
authored andcommitted
refactor: Switch to issue forms
1 parent b3689c2 commit ae326f6

File tree

7 files changed

+129
-82
lines changed

7 files changed

+129
-82
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: 🛠 Bug report
2+
description: Create a report to help us improve
3+
title: Good bug title tells us about precise symptom, not about the root cause.
4+
labels: [bug]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: |
11+
A clear and concise description of what the bug is
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: steps-to-reproduce
16+
attributes:
17+
label: Steps to reproduce
18+
description: Steps to reproduce the behavior
19+
placeholder: |
20+
1. Run ...
21+
2. ...
22+
3. ...
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: current-behavior
27+
attributes:
28+
label: Current behavior
29+
description: What happens actually so you think this is a bug.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: desired-behavior
34+
attributes:
35+
label: Desired behavior
36+
description: |
37+
A clear and concise description of what you expected to happen.
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: screenshots
42+
attributes:
43+
label: Screenshots
44+
description: |
45+
If applicable, add screenshots to help explain your problem.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: environment
50+
attributes:
51+
label: Environment
52+
description: |
53+
For older commitizen versions, please include the output of the following commands manually
54+
placeholder: |
55+
- commitizen version: `cz version`
56+
- python version: `python --version`
57+
- operating system: `python3 -c "import platform; print(platform.system())"`
58+
59+
```bash
60+
cz version --report
61+
```
62+
validations:
63+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Configuration: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository
2+
3+
blank_issues_enabled: false
4+
contact_links:
5+
- name: Security Contact
6+
about: Please report security vulnerabilities to santiwilly@gmail.com

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: 📖 Documentation
2+
description: Suggest an improvement for the documentation of this project
3+
title: Content to be added or fixed
4+
labels: [documentation]
5+
body:
6+
- type: checkboxes
7+
id: typo
8+
attributes:
9+
label: Type
10+
options:
11+
- label: Content inaccurate
12+
- label: Content missing
13+
- label: Typo
14+
- type: input
15+
id: url
16+
attributes:
17+
label: URL
18+
placeholder: |
19+
URL to the code we did not clearly describe or the document page where the content is inaccurate
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Description
26+
description: |
27+
A clear and concise description of what content should be added or fixed
28+
validations:
29+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
title: "<One feature request per issue>"
4+
labels: [feature]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: |
11+
A clear and concise description for us to know your idea.
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: possible-solution
16+
attributes:
17+
label: Possible Solution
18+
description: |
19+
A clear and concise description of what you want to happen.
20+
- type: textarea
21+
id: additional-context
22+
attributes:
23+
label: Additional context
24+
description: |
25+
Add any other context or screenshots about the feature request here.
26+
- type: textarea
27+
id: related-issue
28+
attributes:
29+
label: Additional context
30+
description: |
31+
If applicable, add link to existing issue also help us know better.

0 commit comments

Comments
 (0)