From 3e1fb044db8ad8961294c840c12bdba74f30b6d9 Mon Sep 17 00:00:00 2001 From: init4samwise Date: Thu, 12 Feb 2026 20:03:06 +0000 Subject: [PATCH 1/2] chore: add PR template Closes ENG-1818 --- .github/PULL_REQUEST_TEMPLATE.md | 69 ++++++++++++++++++++++++++++++++ 1 file changed, 69 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..074c94a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,69 @@ +## 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`) +- [ ] Integration tests pass (if applicable) +- [ ] New tests added for new functionality + +## Shared Components Checklist + + + +- [ ] Changes are backwards compatible with consuming repos +- [ ] Public API changes are intentional and documented +- [ ] Downstream impact assessed (signet-node, builder, etc.) +- [ ] Trait changes reviewed for compatibility +- [ ] Feature flags documented (if new ones added) +- [ ] Version bump considered (semver) + +## 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) +- [ ] Migration notes provided (for breaking changes) + +## 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 + + + From ee638c907a319e04602ae3b85ec88c1b880741e7 Mon Sep 17 00:00:00 2001 From: init4samwise Date: Mon, 16 Feb 2026 23:02:02 +0000 Subject: [PATCH 2/2] chore: simplify PR template --- .github/PULL_REQUEST_TEMPLATE.md | 65 ++------------------------------ 1 file changed, 4 insertions(+), 61 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 074c94a..f48aacd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,69 +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) -- [ ] Documentation update -- [ ] CI/CD or tooling changes - -## Changes Made - - - -- + ## Testing - - -- [ ] Unit tests pass (`cargo test`) -- [ ] Integration tests pass (if applicable) -- [ ] New tests added for new functionality - -## Shared Components Checklist - - - -- [ ] Changes are backwards compatible with consuming repos -- [ ] Public API changes are intentional and documented -- [ ] Downstream impact assessed (signet-node, builder, etc.) -- [ ] Trait changes reviewed for compatibility -- [ ] Feature flags documented (if new ones added) -- [ ] Version bump considered (semver) - -## 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) -- [ ] Migration notes provided (for breaking changes) - -## 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 - - - +- [ ] Tests pass locally +- [ ] New tests added (if applicable)