Polish the repo for public contributors - #1
Merged
Conversation
It was left at 2.0.0 when 2.1 was committed.
One compared a literal POSIX path against a value that goes through os.path.abspath; the other compared --abbrev-ref HEAD against git_branch, which cannot match on a detached HEAD.
It was only hidden by a global ignore rule.
Python 3.8 runs on a pinned ubuntu-22.04 runner because setup-python has no 3.8 build for the 24.04 image.
Trailing whitespace, double blank lines, and two stray sentences under Reading the TTL.
Install is reachable without scrolling, the long PATH and settings.json notes moved into collapsible sections, and image.png became docs/statusline.png.
GabrielAndreiPreda
force-pushed
the
polish-for-contributors
branch
from
August 12, 2026 09:45
f52bb40 to
8772292
Compare
GabrielAndreiPreda
added
documentation
The README would have to be edited at every release, and it pointed at a tag that did not exist yet.
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.
Groundwork for taking outside contributions, plus a few things that were wrong rather than missing.
Fixed
__version__still read2.0.0after the 2.1 commit.candidate().argv[0]against a literal/usr/bin/cct, but that value goes throughos.path.abspath, which rewrites it toC:\usr\bin\ccton Windows.test_real_repositorycomparedgit rev-parse --abbrev-ref HEADagainstgit_branch. On a detached HEAD the former answers the literal stringHEADand the latter a short SHA, so it could never match. CI checks PRs out detached, which is how this surfaced..claude/settings.local.jsonwas only hidden by a global git ignore rule.Added
CI on Linux, macOS and Windows across Python 3.8 through 3.13, plus a job that builds the package, checks its metadata, installs the wheel and runs the console script. Python 3.8 runs on a pinned
ubuntu-22.04runner becausesetup-pythonhas no 3.8 build for the 24.04 image thatubuntu-latestnow resolves to.CONTRIBUTING.md, issue and pull request templates, a changelog covering 1.0.0 to 2.1.0, and package metadata (author, project URLs, per-version Python classifiers).Changed
The README reaches the install command without scrolling. The long notes on PATH, shell quoting and
settings.jsonparsing moved into collapsible sections with their wording intact, and a pinned install form is documented since installing frommaingave no way to hold a version.image.pngis nowdocs/statusline.png.Checks
78 tests pass on all seven matrix combinations.
uv buildproduces a 2.1.0 wheel whose metadata carriesLicense-Expression: GPL-3.0-or-laterwith no conflicting classifier.install --dry-runleavessettings.jsonbyte-identical.