Skip to content

Commit

Permalink
Some tweaks to github templates (#4238)
Browse files Browse the repository at this point in the history
  • Loading branch information
dafeder authored Aug 6, 2024
1 parent 3f8e454 commit a8c2395
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 34 deletions.
34 changes: 6 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,21 @@
name: 🐛 Bug Report
description: File a bug/issue
title: "[BUG] <title>"
labels: [🐛 Bug,🤔 Unrefined]
title: "<Short Bug Description>"
labels: [bug]

body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
required: true
- type: textarea
attributes:
label: Steps To Reproduce
Expand All @@ -33,26 +26,11 @@ body:
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS** : Ubuntu 20.04
- **Node** : 13.14.0
- **npm** : 7.6.3
value: |
- OS:
- Node:
- npm:
render: markdown
validations:
required: false
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
label: Relevant log output (optional)
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 💡 Feature Request
description: Suggest a new feature or enhancement for the project.
title: "[Feature] <Short Feature Description>"
labels: [💡 Feature Request]
title: "<Short Feature Description>"
labels: [feature request]

body:
- type: textarea
Expand Down
14 changes: 10 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
fixes [org/repo/issue#]
Fixes [issue#]

- [ ] Test coverage exists
- [ ] Documentation exists
## Describe your changes

## QA Steps

- [ ] Add manual QA steps in checklist format for a reviewer to perform to confirm that the feature or fix is working. Include as much details as possible so that the reviewer doesn't lose time figuring out how to perform steps.
- [ ] Add manual QA steps in checklist format for a reviewer to perform. Be as specific as possible, provide examples if appropriate.

## Checklist before requesting review

_If any of these are left unchecked, please provide an explanation_

- [ ] I have updated or added tests to cover my code
- [ ] I have updated or added documentation

0 comments on commit a8c2395

Please sign in to comment.