Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update issue templates #114

Merged
merged 1 commit into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Bug Report
description: Create a report to help us improve
title: "fix: "
labels: [bug]
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
placeholder: "Describe the bug."
validations:
required: true
- type: textarea
id: setps-to-reproduce
attributes:
label: Steps To Reproduce
description: A set of instructions, step by step, explaining how to reproduce the bug.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
placeholder: "Describe what you expected to happen."
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Build System
description: Changes that affect the build system or external dependencies
title: "build: "
labels: [build]
body:
- type: textarea
id: description
attributes:
label: Description
description: Describe what changes need to be done to the build system and why
placeholder: "Describe the build system change."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/chore.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Chore
description: Other changes that don't modify source or test files
title: "chore: "
labels: [chore]
body:
- type: textarea
id: description
attributes:
label: Description
description: Clearly describe what change is needed and why. If this changes code then please use another issue type.
placeholder: "Provide a description of the chore."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] No functional changes to the code.
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Continuous Integration
description: Changes to the CI configuration files and scripts
title: "ci: "
labels: [ci]
body:
- type: textarea
id: description
attributes:
label: Description
description: Describe what changes need to be done to the CI/CD system and why.
placeholder: "Provide a description of the changes that need to be done to the CI/CD system."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation
description: Improve the documentation so all collaborators have a common understanding
title: "docs: "
labels: [documentation]
body:
- type: textarea
id: description
attributes:
label: Description
description: Clearly describe what documentation you are looking to add or improve.
placeholder: "Provide a description of the documentation changes."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] No functional changes to the code.
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature Request
description: A new feature to be added to the project
title: "feat: "
labels: [feature]
body:
- type: textarea
id: description
attributes:
label: Description
description: Clearly describe what you are looking to add. The more business/user context the better.
placeholder: "Provide a description of the feature."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Performance Update
description: A code change that improves performance
title: "perf: "
labels: [performance]
body:
- type: textarea
id: description
attributes:
label: Description
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.
placeholder: " Provide a description of the performance update."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Refactor
description: A code change that neither fixes a bug nor adds a feature
title: "refactor: "
labels: [refactor]
body:
- type: textarea
id: description
attributes:
label: Description
description: Clearly describe what needs to be refactored and why. Please provide links to related issues (bugs or upcoming features) in order to help prioritize.
placeholder: "Provide a description of the refactor."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/revert.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Revert
description: Revert a previous commit
title: "revert: "
labels: [revert]
body:
- type: textarea
id: description
attributes:
label: Description
description: Provide a link to a PR/Commit that you are looking to revert and why.
placeholder: "Provide a description of and link to the commit that needs to be reverted."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] Change has been reverted.
- [ ] No change in unit/widget test coverage has happened.
- [ ] A new ticket is created for any follow on work that needs to happen.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/style.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Style
description: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
title: "style: "
labels: [style]
body:
- type: textarea
id: description
attributes:
label: Description
description: Clearly describe what you are looking to change and why.
placeholder: "Provide a description of the style changes."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the unit or widget test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Test
description: Adding missing tests or correcting existing tests
title: "test: "
labels: [test]
body:
- type: textarea
id: description
attributes:
label: Description
description: List out the tests that need to be added or changed. Please also include any information as to why this was not covered in the past.
placeholder: "Provide a description of the tests that need to be added or changed."
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
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.
value: |
- [ ] All CI/CD checks are passing.
- [ ] There is no drop in the test coverage percentage.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, including links/screenshots/video recordings/etc about the problem here.
placeholder: "Provide context here."