docs: add release readiness checklist - #214
Merged
El-swaggerito merged 1 commit intoJul 30, 2026
Merged
Conversation
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.
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.
Closes #NNN.npx prettier --writeandnpx prettier --checkon modified files.Issue scope
docs/RELEASE_READINESS_CHECKLIST.mdAffected packages / apps
apps/webpackages/typespackages/configpackages/fixturespackages/validatorspackages/stellar-kitpackages/anchor-utilscontracts/treasury-escrowdocs/Testing performed
npx prettier --write README.md docs/RELEASE_READINESS_CHECKLIST.md docs/MAINTAINER_GUIDE.mdnpx prettier --check README.md docs/RELEASE_READINESS_CHECKLIST.md docs/MAINTAINER_GUIDE.mdScreenshots / recordings
Security impact
Documentation-only change.
Documentation impact
/docsupdated for this change.Maintainer Review Checklist (self-check)
PR self-check
Closes #NNNin the PR body.pnpm verifypasses locally (documentation-only change).pnpm check:boundariespasses locally (not applicable).pnpm contract:testpasses locally (not applicable).Stellar network correctness
Anchor and SEP flow correctness
Payment intent and readiness correctness
Soroban contract correctness (if
contracts/changed)Secret leakage (R0–R6)
Mainnet safety
Tests
Documentation
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.