Skip to content

docs: release checklist + external submission guide for AGENT.md - #248

Merged
ajianaz merged 1 commit into
developfrom
docs/release-checklist-agent-md
Jun 10, 2026
Merged

ajianaz merged 1 commit into
developfrom
docs/release-checklist-agent-md

Conversation

@ajianaz

@ajianaz ajianaz commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Adds comprehensive release preparation process to both AGENT.md and .agent.md, based on lessons learned from the v0.5 development cycle and Trendshift submission preparation.

AGENT.md — New Sections

Pre-Release Checklist (5 sections):

  1. Code — build, test, clippy, binary smoke test
  2. Documentation — every file mapped to what-to-check (13 files)
  3. Cross-Check — feature coverage, terminology, links, versions
  4. CI & Scanning — 10 checks green, 0 Code Scanning alerts
  5. Post-Release — tag trigger, binaries, crates.io, website, marketplace

External Submissions:

  • Description template for Trendshift/directories
  • Key metrics to mention (tests, LOC, CI checks, etc.)
  • Pre-submission checks (docs accuracy, roadmap status)

.agent.md — Restructured

  • Checklist split into Code → Documentation → Cross-Check → CI → Post-Release
  • Added binary smoke test, documentation cross-check
  • Added post-release verification steps

AGENT.md:
- Pre-Release Checklist: 5 sections (Code, Documentation, Cross-Check, CI, Post-Release)
- Documentation table: every file mapped to what-to-check
- Cross-Check: feature coverage, terminology, links, version consistency
- Post-Release: tag trigger, binaries, crates.io, website, marketplace
- External Submissions: description template, key metrics, pre-submission checks

.agent.md:
- Restructured checklist: Code → Documentation → Cross-Check → CI → Post-Release
- Added binary smoke test, documentation cross-check items
- Added post-release verification steps
@ajianaz
ajianaz merged commit 09f34bd into develop Jun 10, 2026
10 checks passed
@ajianaz
ajianaz deleted the docs/release-checklist-agent-md branch June 11, 2026 07:27
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.

1 participant