Adding Issue and PR Templates #29
rbarker-dev
started this conversation in
Ideas
Replies: 4 comments
-
PR Template ## Description
<A brief description of the PR modified files and justification>
### Related Issue(s)
Closes #XXXXX <Use [githubs closing keywords](https://github.com/PandasWhoCode/pwc-site/discussions/29) (closes, fixes, resolves)
### Testing
- [ ] [Link](link to test workflow) <update here with [:runner: :x: or :white_check_mark:] to indicate the status of the test>
- [ ] (any other test case)
### Notes for Reviewer
<Any notes for a reviewer to be aware of when reviewing the PR> |
Beta Was this translation helpful? Give feedback.
0 replies
-
Issue Template (bug report) name: Bug Report
description: File a bug report
#title: "<Please write a short description of what didn't work for you here>"
labels: ["Bug", "Pending Triage"]
body:
- type: textarea
id: actual-behavior
attributes:
label: Describe the bug
description: Also tell us, what did happen?
placeholder: A clear and concise description of what happened.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Describe the expected behavior
description: Also tell us, what did you expect to happen?
placeholder: A clear and concise description of what the expected behavior is.
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context about the problem here.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. |
Beta Was this translation helpful? Give feedback.
0 replies
-
Issue Template (feature request) name: New Feature
description: Request a new feature
#title: "<Please write a brief description of the new feature here>"
labels: ["New Feature", "Pending Triage"]
body:
- type: textarea
id: feature-description
attributes:
label: Requested Feature
description: What would you like added?
placeholder: |
_A clear and concise description of what you want to happen._
validations:
required: true
- type: textarea
id: feature-justification
attributes:
label: Business Need
description: Why is this needed?
placeholder: |
_A clear and concise description of any alternative solutions or features you've considered._
Note: Please provide a clear and concise description of the business need for this feature. This will help us prioritize the feature request.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context or screenshots about the feature request here.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. |
Beta Was this translation helpful? Give feedback.
0 replies
-
Issue Template (Feature Enhancement) name: Feature Enhancement
description: Enhance an existing feature
#title: "<Please write a brief description of the feature enhancement here>"
labels: ["Feature Enhancement", "Pending Triage"]
body:
- type: textarea
id: target-feature
attributes:
label: Feature to Enhance
description: Which existing feature would you like to enhance?
placeholder: |
_A clear and concise description of the feature you want to enhance._
validations:
required: true
- type: textarea
id: enhancement-description
attributes:
label: Requested Enhancement
description: What would you like to enhance or change about this feature?
placeholder: |
_A clear and concise description of what you want to happen._
validations:
required: true
- type: textarea
id: feature-justification
attributes:
label: Business Need
description: Why is this needed?
placeholder: |
_A clear and concise description of any alternative solutions or other features you've considered._
Note: Please provide a clear and concise description of the business need for this enhancement. This will help us prioritize the feature request.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context or screenshots about the feature request here.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
@IamLRBA hsa suggested that we add Issue and PR templates to the
pwc-site
repository to enhance community engagement and ease of access. I think that's a great idea! I am going to post my thoughts for the templates on this discussion. We will take submissions for bothissue
andpr
templates in this forum.Please keep comments to one type of template titled as:
**PR Template**
or**Issue Template**
These templates will be enumerated and voted on in 2 weeks time. (2025-08-30)
Thanks for the suggestion @IamLRBA.
CC: @andrewb1269hg
Thanks,
@rbarker-dev
Beta Was this translation helpful? Give feedback.
All reactions