From d485d7d71f0293f97ab91f9abe26886646af2115 Mon Sep 17 00:00:00 2001 From: init4samwise Date: Thu, 12 Feb 2026 20:03:07 +0000 Subject: [PATCH 1/2] chore: add PR template Closes ENG-1818 --- .github/PULL_REQUEST_TEMPLATE.md | 100 +++++++++++++++++++++++++++++++ 1 file changed, 100 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..4e6ead4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,100 @@ +## 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) +- [ ] Gas optimization +- [ ] Documentation update +- [ ] CI/CD or tooling changes + +## Changes Made + + + +- + +## Testing + + + +- [ ] Unit tests pass (`forge test`) +- [ ] Integration tests pass (if applicable) +- [ ] Fuzz tests pass (if applicable) +- [ ] Fork tests pass (if applicable) +- [ ] New tests added for new functionality +- [ ] Edge cases tested + +## Security Checklist + + + +- [ ] No reentrancy vulnerabilities +- [ ] Integer overflow/underflow handled (or using Solidity 0.8+) +- [ ] Access control is correct +- [ ] External calls are safe (checks-effects-interactions pattern) +- [ ] No front-running vulnerabilities +- [ ] No oracle manipulation risks +- [ ] Proper input validation +- [ ] Events emitted for state changes +- [ ] No hardcoded addresses (unless intentional) +- [ ] Upgrade safety considered (if upgradeable) + +## Gas Considerations + +- [ ] Gas usage is reasonable +- [ ] No unnecessary storage reads/writes +- [ ] Loops are bounded +- [ ] Batch operations considered where applicable + +## Solidity-Specific Checklist + +- [ ] Visibility modifiers are correct +- [ ] State mutability is correct (view/pure where applicable) +- [ ] NatSpec documentation added for public/external functions +- [ ] Error messages are descriptive +- [ ] Custom errors used where appropriate +- [ ] No compiler warnings + +## Code Quality + +- [ ] Code follows the project's style guidelines +- [ ] Self-review completed +- [ ] Comments added for complex logic +- [ ] No debug/console.log statements + +## Documentation + +- [ ] README updated (if needed) +- [ ] NatSpec comments added +- [ ] CHANGELOG updated (if applicable) +- [ ] Interface documentation updated (if applicable) + +## Pre-Submit Checklist + +- [ ] `forge fmt --check` passes +- [ ] `forge build` succeeds without warnings +- [ ] All CI checks pass +- [ ] Branch is up to date with main + +## Deployment Considerations + + + +- [ ] Migration plan documented (if needed) +- [ ] Backwards compatibility verified +- [ ] Upgrade path tested (if applicable) + +## Additional Notes + + + From 35c54e89bc52ef8e77043b9651a573facf0b47ab Mon Sep 17 00:00:00 2001 From: init4samwise Date: Mon, 16 Feb 2026 23:01:58 +0000 Subject: [PATCH 2/2] chore: simplify PR template --- .github/PULL_REQUEST_TEMPLATE.md | 96 ++------------------------------ 1 file changed, 4 insertions(+), 92 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4e6ead4..f48aacd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,100 +1,12 @@ ## 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) -- [ ] Gas optimization -- [ ] Documentation update -- [ ] CI/CD or tooling changes - -## Changes Made - - - -- + ## Testing - - -- [ ] Unit tests pass (`forge test`) -- [ ] Integration tests pass (if applicable) -- [ ] Fuzz tests pass (if applicable) -- [ ] Fork tests pass (if applicable) -- [ ] New tests added for new functionality -- [ ] Edge cases tested - -## Security Checklist - - - -- [ ] No reentrancy vulnerabilities -- [ ] Integer overflow/underflow handled (or using Solidity 0.8+) -- [ ] Access control is correct -- [ ] External calls are safe (checks-effects-interactions pattern) -- [ ] No front-running vulnerabilities -- [ ] No oracle manipulation risks -- [ ] Proper input validation -- [ ] Events emitted for state changes -- [ ] No hardcoded addresses (unless intentional) -- [ ] Upgrade safety considered (if upgradeable) - -## Gas Considerations - -- [ ] Gas usage is reasonable -- [ ] No unnecessary storage reads/writes -- [ ] Loops are bounded -- [ ] Batch operations considered where applicable - -## Solidity-Specific Checklist - -- [ ] Visibility modifiers are correct -- [ ] State mutability is correct (view/pure where applicable) -- [ ] NatSpec documentation added for public/external functions -- [ ] Error messages are descriptive -- [ ] Custom errors used where appropriate -- [ ] No compiler warnings - -## Code Quality - -- [ ] Code follows the project's style guidelines -- [ ] Self-review completed -- [ ] Comments added for complex logic -- [ ] No debug/console.log statements - -## Documentation - -- [ ] README updated (if needed) -- [ ] NatSpec comments added -- [ ] CHANGELOG updated (if applicable) -- [ ] Interface documentation updated (if applicable) - -## Pre-Submit Checklist - -- [ ] `forge fmt --check` passes -- [ ] `forge build` succeeds without warnings -- [ ] All CI checks pass -- [ ] Branch is up to date with main - -## Deployment Considerations - - - -- [ ] Migration plan documented (if needed) -- [ ] Backwards compatibility verified -- [ ] Upgrade path tested (if applicable) - -## Additional Notes - - - +- [ ] Tests pass locally +- [ ] New tests added (if applicable)