Improve README to world-class standard#13
Merged
Conversation
- Add CI, license, and Ruby version badges - Add "Understanding the Output" section documenting the table columns, including the key LOC (surviving lines) vs +LOC/-LOC (lifetime) distinction - Add "Why git_report?" motivation framing it against plain git shortlog - Add Table of Contents and a sharper tagline/intro - Add Quick Start near the top for copy-paste onboarding - Dedupe the vendor/isolation explanation (was repeated in 4 sections) - Name the actual git commands used in "How It Works" - Add troubleshooting cases for "Not a git repository" and permissions
Closed
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.
Summary
Upgrades the README to a world-class standard while keeping every claim grounded in the actual implementation.
Added
LOC(surviving lines viagit blame) vs+LOC/-LOC(lifetime added/deleted viagit log --numstat) distinction that was previously undocumented.git shortlog.Improved
All column semantics, parallelism (
pmap), isolatedvendor/behavior, and the CI matrix were verified against the source.