Skip to content

Add pull request template #647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
reinaldyalt wants to merge 1 commit into from
Closed

Add pull request template #647

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 54 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!--
Thanks for contributing! Please fill in each section as fully as you can.
See CONTRIBUTING.md for the full pull request requirements.
-->

## Summary

<!-- What changed and why. Link the issue this PR addresses: Fixes #NNN -->

## Changes

<!-- List the main changes. Call out affected contracts, public APIs, storage
layouts, events, and deployment behavior. -->

- Affected contracts:
- Public API changes:
- Storage / event changes:
- Deployment impact:

## Testing

<!-- Tests and checks run. PRs must pass CI:
`cargo build --release --target wasm32-unknown-unknown`,
`cargo test --workspace`,
`cargo clippy --workspace --all-targets -- -D warnings`,
`cargo fmt --all -- --check` -->

- [ ] `cargo build --release --target wasm32-unknown-unknown`
- [ ] `cargo test --workspace`
- [ ] `cargo clippy --workspace --all-targets -- -D warnings`
- [ ] `cargo fmt --all -- --check`
- New/updated tests: <!-- describe coverage: happy path, auth failures, validation, boundaries, error paths -->

## Security considerations

<!-- Any security implications, per SECURITY.md. -->

- [ ] Authorization checks preserved on every state-changing entrypoint (`require_auth` on the correct address, called before state reads/writes)
- [ ] No unchecked arithmetic or unbounded storage growth
- [ ] Gas impact assessed (`./scripts/estimate-gas.sh` if execution cost may change):
- [ ] WASM size impact assessed (`./scripts/measure-size.sh` if size may change):

## Breaking Changes

<!-- Clearly labeled. Write `None` when there are no breaking changes. -->

None

## Checklist

- [ ] I read [CONTRIBUTING.md](../CONTRIBUTING.md) and followed the pull request process
- [ ] Documentation and `CHANGELOG.md` updated in this PR (including a **Breaking Changes** entry when applicable)
- [ ] No unrelated formatting, generated files, secrets, or deployment keys included
- [ ] This is not a security vulnerability disclosure (those are reported privately per [SECURITY.md](../SECURITY.md))