archcraft/.github/PULL_REQUEST_TEMPLATE.md

46 lines
1.5 KiB
Markdown
Raw Normal View History

2022-03-30 11:05:39 +00:00
# Description
Please include a summary of the change and which issue is fixed. Please provide the motivation for why this change is necessary at this stage of the product development cycle.
Fixes # (issue)
## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
## User Impact
Please describe any user facing impact of this change. This can be positive or negative impact.
## Performance Impact
Please describe any relevant performance impact of this change. This can be positive or negative impact. How did you characterize/test the performance impact?
# How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so others can reproduce. Please also list any relevant details for your test configuration.
- [ ] Test A
- [ ] Test B
**Software Configuration**:
* Operating System:
* Software version:
* System Specs:
* Graphics Card:
* Etc
# Checklist:
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes