Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
## Description

<!-- Provide a brief description of the changes in this PR -->

## Related Issue

<!-- Link to the Linear ticket this PR addresses -->
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

<!-- List the key changes made in this PR -->

-

## Testing

<!-- Describe the testing performed -->

- [ ] Unit tests pass (`cargo test`)
- [ ] Integration tests pass (if applicable)
- [ ] New tests added for new functionality

## Shared Components Checklist

<!-- Checklist specific to shared node components -->

- [ ] 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

<!-- Any additional context, screenshots, or information for reviewers -->