diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..89fa5354 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,110 @@ + +# Your PR Title Here + +## ๐ŸŽฏ Type of Change + + + +- [ ] ๐Ÿž Bug Fix (a non-breaking change that fixes an issue) + +- [ ] โœจ New Feature (a non-breaking change that adds functionality) + +- [ ] ๐Ÿ’ฅ Breaking Change (a fix or feature that would cause existing functionality to not work as expected) + +- [ ] โšก Performance Optimization (a change that improves the speed or memory usage of the code) + +- [ ] โ™ป๏ธ Refactor (a code change that neither fixes a bug nor adds a feature) + +- [ ] ๐Ÿ“š Documentation Update + +- [ ] ๐Ÿงช Test Suite Addition/Update + +## ๐Ÿ”— Related Issue + + + + + +- Related to Issue: # + +## ๐Ÿ“ Description of Change + + + + +## ๐Ÿ›๏ธ Architectural & Implementation Details + + + + +## ๐Ÿ”ฌ Physics Impact + + + + +## โœ… Validation & Testing + + + +##### Test Configuration: +##### Results: + + +| Model | Final H-1 Mass Fraction | Notes | +|---------|-------------------------|------------------------| +| approx8 | 0.1234 | Matches expected value | + + + +## โฑ๏ธ Performance Impact + + + + +## โ˜‘๏ธ Pre-Merge Checklist + + + +- [ ] My code follows the style guidelines of 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. + +- [ ] 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. + +- [ ] I have confirmed that this PR does not break the AD tape recording process. \ No newline at end of file