Skip to content

docs: add release readiness checklist - #214

Merged
El-swaggerito merged 1 commit into
Axionvera:mainfrom
fredericjasmin:docs/100-release-readiness-checklist
Jul 30, 2026
Merged

docs: add release readiness checklist#214
El-swaggerito merged 1 commit into
Axionvera:mainfrom
fredericjasmin:docs/100-release-readiness-checklist

Conversation

@fredericjasmin

Copy link
Copy Markdown
Contributor

Summary

Closes #100

Adds a Release Readiness Checklist that provides maintainers with a centralized pre-release workflow while reusing the repository's existing verification, security, architecture, and maintenance documentation. The checklist is linked from the README and Maintainer Guide to improve discoverability without duplicating existing guidance.

PR Evidence Checklist

Before requesting review, confirm the following evidence is present in this PR description. Each item links to detailed guidance. PRs missing evidence will be sent back for completion.

  • Issue reference: PR body links the issue with Closes #NNN.
  • Implementation summary: 1–3 sentence description of what changed and why.
  • Tests added or updated: Documentation-only change; no tests required.
  • Commands run: npx prettier --write and npx prettier --check on modified files.
  • CI status: Pending.
  • Acceptance criteria coverage: Included below.

Issue scope

Acceptance Criterion Status Implementation Evidence Tests Notes
Release readiness checklist is added Added docs/RELEASE_READINESS_CHECKLIST.md Documentation review
Package, web, docs, and examples checks are included Checklist Sections 1–4 Documentation review
Security and testnet-safety checks are included Checklist Sections 5–6 Documentation review
Public API review is included Checklist Section 7 Documentation review
Contributor workflow checks are included Checklist Section 8 Documentation review
README links to release documentation README documentation index updated Documentation review

Affected packages / apps

  • apps/web
  • packages/types
  • packages/config
  • packages/fixtures
  • packages/validators
  • packages/stellar-kit
  • packages/anchor-utils
  • contracts/treasury-escrow
  • docs/
  • Other (list):

Testing performed

  • Ran:
    • npx prettier --write README.md docs/RELEASE_READINESS_CHECKLIST.md docs/MAINTAINER_GUIDE.md
    • npx prettier --check README.md docs/RELEASE_READINESS_CHECKLIST.md docs/MAINTAINER_GUIDE.md
  • Prettier formatting passes on all modified files.
  • Repository-wide formatting issues remain pre-existing and unrelated to this PR.
  • No runtime tests were required because this is a documentation-only change.
  • CI status: Pending.

Screenshots / recordings

Before After
N/A N/A

Security impact

  • No security-relevant surface touched.

Documentation-only change.

Documentation impact

  • Docs under /docs updated for this change.
  • README updated (new package, script, or workflow).
  • No user-facing behaviour changed — no docs update needed.

Maintainer Review Checklist (self-check)

PR self-check

  • References the original issue with Closes #NNN in the PR body.
  • Acceptance criteria on the issue are checked off individually in the PR description.
  • pnpm verify passes locally (documentation-only change).
  • pnpm check:boundaries passes locally (not applicable).
  • pnpm contract:test passes locally (not applicable).

Stellar network correctness

  • Not applicable.

Anchor and SEP flow correctness

  • Not applicable.

Payment intent and readiness correctness

  • Not applicable.

Soroban contract correctness (if contracts/ changed)

  • Not applicable.

Secret leakage (R0–R6)

  • Not applicable.

Mainnet safety

  • Not applicable.

Tests

  • Documentation-only change; no tests required.

Documentation

  • Topic docs updated for maintainer release guidance.
  • README documentation index updated.
  • Security docs updated if new threat areas introduced.

Risk / follow-ups

None.

Acceptance Criteria Audit

The acceptance criteria completion table above covers all issue requirements.

GrantFox payment expectations

Merge does not guarantee payment approval. GrantFox evaluation is separate from release readiness and follows the repository's documented contributor evaluation process.

Contributor self-review

Completed. The release checklist centralizes existing release guidance, references existing documentation instead of duplicating it, updates the README and Maintainer Guide for discoverability, and remains fully within the documentation scope of the issue.

@El-swaggerito
El-swaggerito merged commit 0010947 into Axionvera:main Jul 30, 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 AnchorKit release readiness checklist

2 participants