docs: add traceability table for mapping contract changes to acceptan… - #534
Merged
Conversation
…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
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #515
…ce criteria
Closes #515
Pull Request
Issue Reference
Closes #
Summary
Contract Functions Changed
Tests Added or Updated
docs/testing.mddocs/test-coverage.mdupdated to reflect new or changed testsSecurity Considerations
Security checklist (contract changes only)
docs/accounting-invariants.mddocs/atomicity.mdrequire_auth()called on the correct address in every state-changing functiondocs/storage-change-checklist.mddocs/event-compatibility-policy.mdContractErrorvariants withpanic_with_error!, not barepanic!Commands Run
cargo fmt --check— passedcargo clippy --tests -- -D warnings— passedcargo test --workspace— passedCI Status
Acceptance Criteria Coverage