Skip to content

Commit 3b7398c

Browse files
tomarratomarra
authored
chore: update issue templates (#114)
1 parent 233f306 commit 3b7398c

File tree

14 files changed

+333
-40
lines changed

14 files changed

+333
-40
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
title: "fix: "
4+
labels: [bug]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: A clear and concise description of what the bug is.
11+
placeholder: "Describe the bug."
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: setps-to-reproduce
16+
attributes:
17+
label: Steps To Reproduce
18+
description: A set of instructions, step by step, explaining how to reproduce the bug.
19+
placeholder: |
20+
1. Go to '...'
21+
2. Click on '....'
22+
3. Scroll down to '....'
23+
4. See error
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: expected-behavior
28+
attributes:
29+
label: Expected Behavior
30+
description: A clear and concise description of what you expected to happen.
31+
placeholder: "Describe what you expected to happen."
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: additional-context
36+
attributes:
37+
label: Additional Context
38+
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
39+
placeholder: "Provide context here."

‎.github/ISSUE_TEMPLATE/build.yaml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Build System
2+
description: Changes that affect the build system or external dependencies
3+
title: "build: "
4+
labels: [build]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Describe what changes need to be done to the build system and why
11+
placeholder: "Describe the build system change."
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: requirements
16+
attributes:
17+
label: Requirements
18+
description: The list of requirements that need to be met in order to consider the ticket to be completed. Please be as explicit as possible.
19+
value: |
20+
- [ ] All CI/CD checks are passing.
21+
- [ ] There is no drop in the test coverage percentage.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: additional-context
26+
attributes:
27+
label: Additional Context
28+
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
29+
placeholder: "Provide context here."

‎.github/ISSUE_TEMPLATE/chore.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Chore
2+
description: Other changes that don't modify source or test files
3+
title: "chore: "
4+
labels: [chore]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Clearly describe what change is needed and why. If this changes code then please use another issue type.
11+
placeholder: "Provide a description of the chore."
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: requirements
16+
attributes:
17+
label: Requirements
18+
description: The list of requirements that need to be met in order to consider the ticket to be completed. Please be as explicit as possible.
19+
value: |
20+
- [ ] No functional changes to the code.
21+
- [ ] All CI/CD checks are passing.
22+
- [ ] There is no drop in the test coverage percentage.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: additional-context
27+
attributes:
28+
label: Additional Context
29+
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
30+
placeholder: "Provide context here."

‎.github/ISSUE_TEMPLATE/ci.yaml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Continuous Integration
2+
description: Changes to the CI configuration files and scripts
3+
title: "ci: "
4+
labels: [ci]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Describe what changes need to be done to the CI/CD system and why.
11+
placeholder: "Provide a description of the changes that need to be done to the CI/CD system."
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: requirements
16+
attributes:
17+
label: Requirements
18+
description: The list of requirements that need to be met in order to consider the ticket to be completed. Please be as explicit as possible.
19+
value: |
20+
- [ ] All CI/CD checks are passing.
21+
- [ ] There is no drop in the test coverage percentage.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: additional-context
26+
attributes:
27+
label: Additional Context
28+
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
29+
placeholder: "Provide context here."

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Documentation
2+
description: Improve the documentation so all collaborators have a common understanding
3+
title: "docs: "
4+
labels: [documentation]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Clearly describe what documentation you are looking to add or improve.
11+
placeholder: "Provide a description of the documentation changes."
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: requirements
16+
attributes:
17+
label: Requirements
18+
description: The list of requirements that need to be met in order to consider the ticket to be completed. Please be as explicit as possible.
19+
value: |
20+
- [ ] No functional changes to the code.
21+
- [ ] All CI/CD checks are passing.
22+
- [ ] There is no drop in the test coverage percentage.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: additional-context
27+
attributes:
28+
label: Additional Context
29+
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
30+
placeholder: "Provide context here."

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature Request
2+
description: A new feature to be added to the project
3+
title: "feat: "
4+
labels: [feature]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Clearly describe what you are looking to add. The more business/user context the better.
11+
placeholder: "Provide a description of the feature."
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: requirements
16+
attributes:
17+
label: Requirements
18+
description: The list of requirements that need to be met in order to consider the ticket to be completed. Please be as explicit as possible.
19+
value: |
20+
- [ ] All CI/CD checks are passing.
21+
- [ ] There is no drop in the test coverage percentage.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: additional-context
26+
attributes:
27+
label: Additional Context
28+
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
29+
placeholder: "Provide context here."

‎.github/ISSUE_TEMPLATE/performance.yaml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Performance Update
2+
description: A code change that improves performance
3+
title: "perf: "
4+
labels: [performance]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Clearly describe what code needs to be changed and what the performance impact is going to be. Bonus point's if you can tie this directly to user experience.
11+
placeholder: " Provide a description of the performance update."
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: requirements
16+
attributes:
17+
label: Requirements
18+
description: The list of requirements that need to be met in order to consider the ticket to be completed. Please be as explicit as possible.
19+
value: |
20+
- [ ] All CI/CD checks are passing.
21+
- [ ] There is no drop in the test coverage percentage.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: additional-context
26+
attributes:
27+
label: Additional Context
28+
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
29+
placeholder: "Provide context here."

0 commit comments

Comments
 (0)