docs: curated human-readable CHANGELOG (satisfies BestPractices release_notes)#51
Merged
docs: curated human-readable CHANGELOG (satisfies BestPractices release_notes)#51
Conversation
OpenSSF BestPractices criterion release_notes requires a human-readable summary of major changes per release — explicitly "MUST NOT be the raw output of a version control log". Prior CHANGELOG was a stub pointing at GitHub's auto-generated PR list, which is the disqualified form. This revision: - Writes v0.0.1 as a "first stable release" overview covering what the product does (GraphRAG pipeline, loaders, LLM layer, query engine, surfaces, storage) and known limitations. - Writes v0.0.2 as a targeted CI-cadence note with explicit "upgrade impact: drop-in replacement" guidance. - Tracks the Unreleased branch-state for governance files, release pipeline rewrite, and CI simplifications. The on-GitHub v0.0.1 and v0.0.2 release bodies have been updated with the same curated content via gh release edit. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 tasks
aksOps
added a commit
that referenced
this pull request
Apr 23, 2026
…ation at CHANGELOG.md (#53) - README.md: add BestPractices badge (project 12628) next to the Security Scan + OpenSSF Score badges. - .bestpractices.json: release_notes_justification now points at the curated CHANGELOG.md (the single source of truth after PR #51/#52), not the raw-PR-list GitHub releases page. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Why
OpenSSF BestPractices `release_notes` explicitly says:
Our v0.0.1 and v0.0.2 GitHub release bodies were just the auto-generated PR list (`--generate-notes` output) — disqualified. The prior `CHANGELOG.md` was a stub pointing at those same auto-generated bodies.
Changes
CHANGELOG.md — rewritten as a curated human-readable log:
GitHub release bodies — already updated via `gh release edit` for v0.0.1 and v0.0.2 with the same curated content. Takes effect immediately; CHANGELOG.md is the in-repo permanent form.
What this unlocks
Test plan
🤖 Generated with Claude Code