diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ebed0920..9b60fdc1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1,40 @@ -# Description of change -Please write a summary of your changes and why you made them. - -## Links to any relevant issues -Be sure to reference any related issues by adding `fixes issue #`. - -## How the change has been tested -Describe the tests that you ran to verify your changes. -Make sure to provide instructions for the maintainer as well as any relevant configurations. - -## Definition of Done checklist -Add an `x` to the boxes that are relevant to your changes. - -- [ ] I have followed the contribution guidelines for this project -- [ ] 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 -- [ ] 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 -- [ ] I have successfully tested this change in a docker environment +# 1. The Principle: Definition of Done + +"Done" means the work is ready for production and considerate of future maintainers. Work is not "done" until: + +* **Reviewers** understand *what* was done and *why*. +* **Testers** clearly understand *how* to verify it. +* **Future Developers** can understand the code and its purpose without context switching. +* **The Product** is measurably better. + +--- + +# 2. Pull Request (PR) Template + +## Description & Purpose +Please explain the feature and how it furthers the product (technical or business value). + +## Changes Made +High-level summary of technical changes. + +## Related Issues +## Testing Instructions +Step-by-step instructions for the reviewer to verify the work. + +--- + +# 3. Ready-to-Merge Checklist +Please review your own work and check the following boxes before requesting a review. + +### Code Quality +- [ ] Clean Code +- [ ] Clarity + +### Testing +- [ ] Coverage +- [ ] Passes +- [ ] Verified + +### Documentation +- [ ] Docs +- [ ] Context