diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..12e5856 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +## Description +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +## Type of Change +- [ ] 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) +- [ ] Documentation update +- [ ] Refactoring (no functional change, code cleanup) +- [ ] Performance improvement + +## Code Review Process +**IMPORTANT**: This project maintains an extremely high standard for code quality and correctness. By submitting this pull request, you acknowledge and agree to the following: + +1. **You must be able to defend every single line of code you have added or modified** +2. **You must be prepared to explain the reasoning behind every design decision** +3. **You must be able to discuss and justify your approach to solving the problem** +4. **You must be ready to address all feedback and make requested changes** +5. **You must have thoroughly tested your changes and be confident in their correctness** + +The code review process for this project is intentionally tedious and thorough. Do not submit a pull request unless you are prepared to defend your PR changes. + +## Breaking Changes +If this change introduces any breaking changes, please describe them here. + +## Checklist +- [ ] My code follows the project's coding style guidelines +- [ ] 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 read the project's CONTRIBUTING guidelines +- [ ] I understand and agree to the rigorous code review process described above