Repository navigation
README: clearer versioning docs for users and maintainers - #7
Merged
Merged
Conversation
Users get install, team setup, update (the command was never given) and pinning in one place, and the README no longer promises a team repo needs no install step. Maintainers get a what-to-bump table and what each failing check means. Release internals move to the end. Same length as before. check-bumps now fails when a package's __version__ disagrees with its pyproject.toml, since `cap --version` prints the former. 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
1 participant
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.
Reorganises the README so each audience can find what it needs. The file stays the same length.
Users (in "Using the plugin"):
claude plugin installonceMaintainers:
The details of how releases are automated (tags, workflows, nightly, older tags) move to the end.
Also:
check-bumpsnow fails if__version__disagrees withpyproject.toml. The README tells you to bump both, but nothing checked it, andcap --versionprints__version__. This comes with a test.Nothing changes under
plugins/, so no version bump../dev.shandcheck-bumpspass.🤖 Generated with Claude Code