Skip to content

docs: expand acceptance criteria audit evidence - #550

Closed
CleanDev-Fix wants to merge 2 commits into
Axionvera:mainfrom
CleanDev-Fix:codex/grantfox-540-acceptance-audit
Closed

docs: expand acceptance criteria audit evidence#550
CleanDev-Fix wants to merge 2 commits into
Axionvera:mainfrom
CleanDev-Fix:codex/grantfox-540-acceptance-audit

Conversation

@CleanDev-Fix

Copy link
Copy Markdown

Closes #540

Summary

Extends the existing Traceability Table into the canonical acceptance criteria
audit requested by this issue. The table now records generic implementation
evidence and documentation impact while preserving test, edge-case, and status
evidence.

Changes

  • add Implementation Evidence and Documentation Impact columns, definitions,
    examples, and incomplete-criteria guidance to
    docs/traceability-table.md;
  • align .github/PULL_REQUEST_TEMPLATE.md with the seven-column audit; and
  • update CONTRIBUTING.md, docs/self-review-template.md, and README.md to
    reference the same canonical audit.

Contract Functions Changed

None. This is a documentation/template-only change.

Tests Added or Updated

None. No executable or contract behavior changed.

Security Considerations

No security impact. The patch does not alter balances, authorization, storage,
events, external calls, dependencies, or workflows.

Commands Run

  • git diff --check — PASS (line-ending warnings only; no whitespace errors)
  • six acceptance-criteria content assertions — PASS
  • Markdown table column/row consistency — PASS
  • repository-relative links added by this patch — PASS
  • independent QA — PASS, no blocking or actionable findings

The Rust/contract suite was not run because the patch changes Markdown and the
PR template only.

CI Status

This PR is intentionally a draft until relevant hosted checks are visible and
green.

Traceability Table

Criterion ID Criterion Text Implementation Evidence Test Evidence Documentation Impact Edge Cases Covered Status
AC-1 Acceptance criteria audit template is added Identified and extended the existing Traceability Table instead of adding a duplicate N/A — documentation/template change docs/traceability-table.md, .github/PULL_REQUEST_TEMPLATE.md Existing edge/status evidence preserved Met
AC-2 Template includes implementation evidence Added the generic Implementation Evidence column and definition Content and table checks Guide, template, self-review, contributor guide, and README aligned Documentation-only criteria and function/logic examples included Met
AC-3 Template includes test evidence Renamed and defined Test Evidence with names, paths, and reasoned N/A guidance Content and table checks docs/traceability-table.md, .github/PULL_REQUEST_TEMPLATE.md Multiple-test example retained and updated Met
AC-4 Template includes documentation impact Added Documentation Impact with affected-file or reasoned N/A guidance Content and table checks All five changed files reference the audit consistently Existing-docs and changed-doc examples included Met
AC-5 Incomplete criteria handling is explained Expanded Partial/deferred guidance to require implementation gaps, deferred docs, and follow-up issue linkage Content assertion docs/traceability-table.md Partial worked row included Met
AC-6 PR template or contributor docs reference the audit PR template calls it the canonical audit; CONTRIBUTING and self-review link the guide Relative-link check .github/PULL_REQUEST_TEMPLATE.md, CONTRIBUTING.md, docs/self-review-template.md, README.md N/A Met

Contributor Self-Review

  • Every issue acceptance criterion is mapped above.
  • The patch stays within the issue and extends the existing table rather
    than adding a duplicate.
  • No contract, authorization, storage, event, dependency, or workflow
    behavior changes.
  • Patch-added links, table structure, required content, and independent QA
    pass.
  • Hosted CI is pending; this PR remains a draft.

Known limitation: the Rust/contract suite was not run because no executable
behavior changed.

@El-swaggerito

Copy link
Copy Markdown
Contributor
\nThis PR is currently a draft.\n\nThe auto-merge automation will not merge draft pull requests.

@CleanDev-Fix

Copy link
Copy Markdown
Author

Closing this draft to avoid competing with the accepted assignee. Issue #540 is now assigned to @Bilalishaq7.

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 PocketPay Contracts acceptance criteria audit template

2 participants