From 6ed469ef8a8bc871de96fa9af50d3200260c833d Mon Sep 17 00:00:00 2001 From: kitWarse <278602811+kitWarse@users.noreply.github.com> Date: Sun, 31 May 2026 13:54:06 +0100 Subject: [PATCH] docs: add contracts pre-pr checklist --- .github/PULL_REQUEST_TEMPLATE.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c7f9a23..e071f40 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,6 +11,9 @@ ## Checklist - [ ] Linked issue or backlog item -- [ ] Contract behavior and invariants are described clearly -- [ ] Docs updated if contract interfaces or workflows changed -- [ ] Scope stays limited to one contract concern +- [ ] Added or updated `creator-keys` unit/integration tests for every changed contract behavior, including failure paths for new or reachable `ContractError` variants +- [ ] Ran `cargo fmt --all -- --check`, `cargo clippy --workspace --all-targets -- -D warnings`, and `cargo test --workspace`, or explained exactly why a command was not run +- [ ] Reviewed persistent storage changes against `docs/storage-key-invariants.md`; any storage layout change includes a migration/backward-compatibility note +- [ ] Confirmed event names, topic order, payload field order, and field meanings remain compatible with `docs/contract-event-conventions.md`, or documented the breaking change and versioning plan +- [ ] Updated docs for any changed public contract interface, read-only method, event schema, storage behavior, fee logic, or deployment workflow +- [ ] Scope stays limited to one contract concern and does not include unrelated formatting, lockfile, generated artifact, or dependency changes