Prepare the README and changelog for a public launch - #3
Merged
Conversation
The first run on a mature codebase reports roughly ten warnings per file -- measured at 57 errors, 1862 warnings and 395 info over 167 stdlib files -- and a wall of findings is the usual reason a linter gets closed and never reopened. The README now opens on the low-noise path (errors first, then a baseline, then that as the CI command) before the full usage firehose. Add a "How it compares" section with measured numbers rather than claims. Ruff is roughly 13x faster and has 30x the rules, and the section says so plainly; being straight about that is worth more than the comparison flatters. Among the Python-implemented checkers CodeSnake is the quick one, about 5x faster than Bandit and 10x faster than pylint on the same files. Methodology and the pylint flags used are noted so the numbers can be checked. The header now leads with the two properties that actually differentiate the tool -- it never imports or executes analyzed code, and it has no runtime dependencies -- rather than with the AST implementation detail. Also adds CI, PyPI, Python-version and license badges, and CHANGELOG.md covering 1.1.0 and 1.2.0 in Keep a Changelog format. Verified: every internal README link resolves, the three onboarding commands work end to end on a fresh file, and the benchmark figures are best-of-run measurements on Python 3.12, not estimates. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0114gUUe4CxYr8W8oC95ffmD
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.
The first run on a mature codebase reports roughly ten warnings per file --
measured at 57 errors, 1862 warnings and 395 info over 167 stdlib files -- and
a wall of findings is the usual reason a linter gets closed and never
reopened. The README now opens on the low-noise path (errors first, then a
baseline, then that as the CI command) before the full usage firehose.
Add a "How it compares" section with measured numbers rather than claims. Ruff
is roughly 13x faster and has 30x the rules, and the section says so plainly;
being straight about that is worth more than the comparison flatters. Among
the Python-implemented checkers CodeSnake is the quick one, about 5x faster
than Bandit and 10x faster than pylint on the same files. Methodology and the
pylint flags used are noted so the numbers can be checked.
The header now leads with the two properties that actually differentiate the
tool -- it never imports or executes analyzed code, and it has no runtime
dependencies -- rather than with the AST implementation detail.
Also adds CI, PyPI, Python-version and license badges, and CHANGELOG.md
covering 1.1.0 and 1.2.0 in Keep a Changelog format.
Verified: every internal README link resolves, the three onboarding commands
work end to end on a fresh file, and the benchmark figures are best-of-run
measurements on Python 3.12, not estimates.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_0114gUUe4CxYr8W8oC95ffmD