Update PULL_REQUEST_TEMPLATE.md
cut it down a lot
This commit is contained in:
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,43 +1,9 @@
|
|||||||
# Bug Fix PR Template
|
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
Provide a concise description of the bug and the fix.
|
Provide description of the bug (if an issue exists, link to it) and the fix.
|
||||||
|
|
||||||
## Issue Link
|
|
||||||
|
|
||||||
Link to the issue being addressed.
|
|
||||||
|
|
||||||
## Root Cause Analysis
|
|
||||||
|
|
||||||
Detail the root cause of the bug and how it was identified.
|
|
||||||
|
|
||||||
## Changes
|
|
||||||
|
|
||||||
Outline the changes made to fix the bug.
|
|
||||||
|
|
||||||
## Impact
|
|
||||||
|
|
||||||
Describe any implications this fix may have on other parts of the application.
|
|
||||||
|
|
||||||
## Testing Strategy
|
|
||||||
|
|
||||||
Explain how the fix has been tested to ensure the bug is resolved without introducing new issues.
|
|
||||||
|
|
||||||
## Regression Risk
|
|
||||||
|
|
||||||
Assess the risk of regression caused by this fix and steps taken to mitigate it.
|
|
||||||
|
|
||||||
## Checklist
|
## Checklist
|
||||||
|
|
||||||
- [ ] The fix has been locally tested
|
|
||||||
|
|
||||||
- [ ] The fix meets the codestyle requirements
|
- [ ] The fix meets the codestyle requirements
|
||||||
|
|
||||||
- [ ] New unit tests have been added to prevent future regressions
|
- [ ] New unit tests have been added to prevent future regressions
|
||||||
|
|
||||||
- [ ] The documentation has been updated if necessary
|
- [ ] The documentation has been updated if necessary
|
||||||
|
|
||||||
## Additional Notes
|
|
||||||
|
|
||||||
Any further information needed to understand the fix or its impact.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user