Skip to content

docs: add a maintainer release checklist #29

Description

@afurm

Release mechanics are intentionally not front-and-center in the README, but maintainers still need a concise checklist for cutting patch releases.

Scope:

  • Add a short maintainer-facing release checklist outside the main README flow.
  • Cover version bump, changelog update, full validation, GitHub Release tag naming, npm package verification, and rollback notes.
  • Keep public install instructions in README.md concise.

Acceptance criteria:

  • A maintainer can prepare a v0.1.x release without reading workflow YAML directly.
  • The README stays focused on users and contributors, not release automation internals.
  • The checklist references CHANGELOG.md.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions