Skip to content

Add contracts acceptance criteria traceability table #515

Description

@El-swaggerito

Description

Difficulty: Expert

Type: Documentation

Summary

Add a traceability table format for mapping contract changes to issue acceptance criteria.

Current Behaviour

Contract contributors may not show how each acceptance criterion was satisfied.

Expected Behaviour

Contract PRs should clearly map changed functions, tests, and edge cases to issue criteria.

Suggested Implementation

Create docs, PR template section, and example traceability table.

Files or Areas Likely Affected

  • docs/
  • .github/
  • README.md

Acceptance Criteria

  • Traceability table is documented.
  • Changed contract functions are mapped.
  • Tests are mapped to criteria.
  • Edge cases are included.
  • PR template references the table.
  • README links to docs.

Additional Notes

This improves evaluation readiness.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelcontractSmart contract related workdeveloper-experienceDeveloper experience workdocumentationDocumentation workexpertExpert difficulty

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions