Skip to content

Commit 7f5862f

Browse files
carloscuestacarloscuesta
committed
📝 Add ISSUE_TEMPLATES (#896)
1 parent 78f1813 commit 7f5862f

File tree

5 files changed

+124
-16
lines changed

5 files changed

+124
-16
lines changed

‎.github/ISSUE_TEMPLATE.md

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

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: 🐛 Bug report
2+
description: Report an issue
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thanks for taking the time to fill out this bug report!
8+
- type: textarea
9+
id: bug-description
10+
attributes:
11+
label: Describe the bug
12+
description: A clear description the bug. If you want to contribute to fix this issue, tell us in the description.
13+
placeholder: Description
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: reproduction
18+
attributes:
19+
label: Reproduction
20+
description: A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is **required**, otherwise the issue might be closed without further notice.
21+
placeholder: Reproduction
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: system-info
26+
attributes:
27+
label: System Info
28+
description: Output of `npx envinfo --system --binaries --browsers`
29+
render: Shell
30+
placeholder: Paste the output of the following command
31+
validations:
32+
required: true
33+
- type: checkboxes
34+
id: validations
35+
attributes:
36+
label: Validations
37+
description: Before submitting the issue, please make sure you do the following
38+
options:
39+
- label: Follow our [Code of Conduct](https://github.com/carloscuesta/gitmoji-cli/blob/master/CODE_OF_CONDUCT.md)
40+
required: true
41+
- label: Read the [Contributing Guide](https://github.com/carloscuesta/gitmoji-cli/blob/master/.github/CONTRIBUTING.md).
42+
required: true
43+
- label: Check that there isn't already an issue that reports the same bug to avoid creating duplicates.
44+
required: true
45+
- label: Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
46+
required: true
47+
- label: The provided reproduction is a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
48+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 😍 Contribution Guide
4+
url: https://github.com/carloscuesta/gitmoji-cli/blob/master/.github/CONTRIBUTING.md
5+
about: Please read through before making any contribution.

‎.github/ISSUE_TEMPLATE/discussion.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: ⁉️ Discussion
2+
description: Want to discuss something? Use this template
3+
labels: [discussion]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for your interest in the project and taking the time to fill out this discussion report!
9+
- type: textarea
10+
id: discussion-description
11+
attributes:
12+
label: Discussion
13+
description: 'Explain the matter here!'
14+
validations:
15+
required: true
16+
- type: checkboxes
17+
id: checkboxes
18+
attributes:
19+
label: Validations
20+
description: Before submitting the issue, please make sure you do the following
21+
options:
22+
- label: Follow our [Code of Conduct](https://github.com/carloscuesta/gitmoji-cli/blob/master/CODE_OF_CONDUCT.md)
23+
required: true
24+
- label: Read the [Contributing Guide](https://github.com/carloscuesta/gitmoji-cli/blob/master/.github/CONTRIBUTING.md).
25+
required: true
26+
- label: Check that there isn't already an issue requesting the same feature.
27+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 🚀 Feature proposal
2+
description: Propose a new feature
3+
labels: [feature]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for your interest in the project and taking the time to fill out this feature report!
9+
- type: textarea
10+
id: feature-description
11+
attributes:
12+
label: Description of the problem
13+
description: 'As a user I want [goal] so that [benefit]. If you want to contribute with a PR, tell us in the description. Thanks!'
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: suggested-solution
18+
attributes:
19+
label: Solution
20+
description: 'In module [xy] we could provide following implementation...'
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternative
25+
attributes:
26+
label: Alternatives
27+
description: Explain any alternative solutions or features you've considered.
28+
- type: textarea
29+
id: additional-context
30+
attributes:
31+
label: Additional context
32+
description: Any other context or screenshots about the feature.
33+
- type: checkboxes
34+
id: checkboxes
35+
attributes:
36+
label: Validations
37+
description: Before submitting the issue, please make sure you do the following
38+
options:
39+
- label: Follow our [Code of Conduct](https://github.com/carloscuesta/gitmoji-cli/blob/master/CODE_OF_CONDUCT.md)
40+
required: true
41+
- label: Read the [Contributing Guide](https://github.com/carloscuesta/gitmoji-cli/blob/master/.github/CONTRIBUTING.md).
42+
required: true
43+
- label: Check that there isn't already an issue requesting the same feature.
44+
required: true

0 commit comments

Comments
 (0)