Repository navigation
Add a changelog and contributing guide, and simplify the README - #23
Merged
Merged
Conversation
- CHANGELOG.md holds each release's notes, starting with 0.5.0. The release workflow publishes the version's section, followed by the pull requests GitHub lists, grouped by label (.github/release.yml). - CONTRIBUTING.md covers the checks, pull requests, writing style and how AI agents may be used: the person who submits a change owns it. - The README lists every dock action, launcher command and setting in tables, with less prose. Co-Authored-By: Claude Opus 5.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.
Release notes
CHANGELOG.mdholds the user-facing notes for each release, starting with 0.5.0. Changes collect underUnreleased, and the release PR renames that section to the new version.release.ymlnow publishes the version'sCHANGELOG.mdsection, followed by GitHub's generated pull request list in a collapsed block. The release fails if the changelog has no section for the tag, so notes can't be forgotten..github/release.ymlgroups that list into New, Fixes and Under the hood by label. It leaves out PRs labelledreleaseorskip-changelog; I've created both labels.CONTRIBUTING.md
README
file_search_exclude.CONTRIBUTING.md.Verification
I ran the new notes step locally against the
v0.5.0tag. It produced the changelog section followed by the collapsed pull request list.🤖 Generated with Claude Code