From a475252f709fbbfd0369219c2315897b5b1277e7 Mon Sep 17 00:00:00 2001 From: init4samwise Date: Thu, 12 Feb 2026 20:03:09 +0000 Subject: [PATCH] chore: add PR template Closes ENG-1818 --- .github/PULL_REQUEST_TEMPLATE.md | 70 ++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..bd727d2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,70 @@ +## Description + + + +## Related Issue + + +Closes ENG-XXXX + +## Type of Change + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Refactoring (no functional changes) +- [ ] Documentation update +- [ ] CI/CD or tooling changes + +## Changes Made + + + +- + +## Testing + + + +- [ ] Unit tests pass (`cargo test`) +- [ ] EVM execution tests pass +- [ ] Doc tests pass (`cargo test --doc`) +- [ ] New tests added for new functionality + +## EVM Library Checklist + + + +- [ ] EVM execution semantics preserved +- [ ] Gas calculation changes are intentional and correct +- [ ] State transitions are correct +- [ ] Public API changes documented +- [ ] Breaking changes noted (if any) +- [ ] Performance impact assessed for hot paths +- [ ] Edge cases handled (empty input, max values, etc.) + +## Code Quality + +- [ ] Code follows the project's style guidelines +- [ ] Self-review completed +- [ ] Comments added for complex logic +- [ ] No unnecessary debug/print statements +- [ ] Error handling is appropriate + +## Documentation + +- [ ] README updated (if needed) +- [ ] Rustdoc comments added for public items +- [ ] CHANGELOG updated (if applicable) +- [ ] Examples updated (if applicable) + +## Pre-Submit Checklist + +- [ ] `cargo fmt --check` passes +- [ ] `cargo clippy` passes without warnings +- [ ] All CI checks pass +- [ ] Branch is up to date with main + +## Additional Notes + +