Repository navigation
docs: add CHANGELOG.md and a docs-update policy - #45
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5 <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.
Summary
Part of a workspace-wide rollout (see
FAST-HEP/fasthep-dev, task2026-10-26-package-docs-rollout) giving every FAST-HEP package a realCHANGELOG.mdand a stated policy for keeping it current. Nodocs/tree exists here yet, so no Sphinx page is added (theAGENTS.mdentry says so explicitly).CHANGELOG.mdis backfilled with real content: a## [2026.08.2]section covering the last tagged release, and a populated## [Unreleased]section covering thefasthep-toolbench[display,http]extras change and the progress-typing fix.Evidence
Before: no
CHANGELOG.md, no stated docs-update policy.After: content verified by direct inspection against
git log 2026.08.1..2026.08.2andgit log 2026.08.2..origin/main.Merge Danger
Documentation-only. No source, test, or dependency changes. Zero behavioural risk.
AI-assisted contributions
This PR's content was generated by Claude (Sonnet 5), orchestrated by @kreczko across a multi-session workspace effort. What was AI-generated: the
CHANGELOG.mdcontent (synthesized fromgit logbetween tags, grouped into user-facing bullets, categorized per Keep a Changelog), and theAGENTS.mdpolicy section (templated identically across all participating repos). What was reviewed: the repository owner read and approved the diff before pushing (this workspace's standard two-gate review: push, then PR). Known limitation: theCHANGELOG.mdbackfill is a best-effort reconstruction from commit history, not a release-time verbatim record.🤖 Generated with Claude Code