Repository navigation
docs: refine changelog entries and guidance - #426
Merged
Merged
Conversation
Overhaul CHANGELOG.md, CHANGELOG-OLD.md, and the changelog rules in AGENTS.md so release notes read consistently from a caller's perspective across current and historical releases. - Standardize section headings and category ordering (`Breaking changes`, `Notable changes`, `New features`, `Improvements`, `Performance improvements`, `Bug fixes`), separating non-performance improvements from workload-scoped performance claims. - Rewrite entries in CHANGELOG.md and CHANGELOG-OLD.md to name affected public APIs, observable behavior, migration paths, and performance scope or tradeoffs while removing pull request links and internal implementation mechanics. - Reconcile missing or conflated entries across v0.6.0 through Unreleased against the shipped code, keeping v0.8.0 undated until publication. - Update AGENTS.md with the standardized category order, workload-scoping rule, and release dating workflow.
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
CHANGELOG.md(v0.7.0throughUnreleased) andCHANGELOG-OLD.md(v0.6.0throughv0.6.7), separating non-performanceImprovementsfromPerformance improvements.v0.7.0, conciseSemaphoreandshutdownmigrations, merged error-unwind entries inv0.7.3, and non-perf vs. performance separation across releases) while keeping## v0.8.0undated pending release.## Changelogrules inAGENTS.mdto codify category ordering, caller-centric framing, workload scoping for performance claims, and adding the UTC release date only after publication.Validation
git diff --checkwith no whitespace errors.cargo x lint(clippy --tests --all-features --all-targets --workspace,rustfmt --all --check,taplo format --check,typos,hawkeye check, andcargo doc --workspace --all-features --no-deps).