Skip to content

docs: add traceability table for mapping contract changes to acceptan… - #534

Merged
El-swaggerito merged 1 commit into
Axionvera:mainfrom
iamdikko:issue515
Jul 28, 2026
Merged

docs: add traceability table for mapping contract changes to acceptan…#534
El-swaggerito merged 1 commit into
Axionvera:mainfrom
iamdikko:issue515

Conversation

@iamdikko

Copy link
Copy Markdown
Contributor

Closes #515
…ce criteria

  • Create docs/traceability-table.md with 6-column table format, worked example, and usage rules
  • Update PR template: replace Acceptance Criteria Coverage section with the richer Traceability Table section referencing the new guide
  • Update README: add doc link in Documentation section and traceability requirement in Contributing section

Closes #515

Pull Request

Issue Reference

Closes #


Summary

Contract Functions Changed

Function Change type (added / modified / removed) Notes

Tests Added or Updated

  • Happy-path tests added/updated
  • Failure and boundary-condition tests added/updated
  • Test naming follows the convention in docs/testing.md
  • docs/test-coverage.md updated to reflect new or changed tests

Security Considerations

Security checklist (contract changes only)

  • Balance & accounting invariants preserved — see docs/accounting-invariants.md
  • Lock state and timed-operation rules unchanged (or documented if changed)
  • Token transfer atomicity maintained — see docs/atomicity.md
  • require_auth() called on the correct address in every state-changing function
  • Storage layout change checklist followed (if applicable) — see docs/storage-change-checklist.md
  • Event backward-compatibility policy followed (if applicable) — see docs/event-compatibility-policy.md
  • New error codes use ContractError variants with panic_with_error!, not bare panic!
  • No secrets, private keys, or credentials committed or logged

Commands Run

cargo fmt --check
cargo clippy --tests -- -D warnings
cargo test --workspace
  • cargo fmt --check — passed
  • cargo clippy --tests -- -D warnings — passed
  • cargo test --workspace — passed

CI Status

  • All CI checks pass on this branch

Acceptance Criteria Coverage

Criterion Met? Notes

…ce criteria

- Create docs/traceability-table.md with 6-column table format, worked
  example, and usage rules
- Update PR template: replace Acceptance Criteria Coverage section with
  the richer Traceability Table section referencing the new guide
- Update README: add doc link in Documentation section and traceability
  requirement in Contributing section

Closes Axionvera#515
@El-swaggerito
El-swaggerito merged commit 2113760 into Axionvera:main Jul 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add contracts acceptance criteria traceability table

3 participants