Skip to content

Commit 4d09a1e

Browse files
committed
Clarify "lines changed" disclaimer
1 parent 1584f67 commit 4d09a1e

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,27 +47,27 @@ would be unable to access.
4747

4848
The GitHub statistics API returns inaccurate results in some situations:
4949

50+
- Total lines of code modified may be inflated – GitHub counts changes to files
51+
like `package-lock.json` that may impact the line count in surprising ways
52+
- On the other hand, GitHub refuses to count lines of code for repositories
53+
with more than 10,000 commits, so contributions to those will not be
54+
reflected in the data at all
55+
- [The GitHub API endpoint for computing contributor statistics no longer
56+
works reliably](https://github.com/orgs/community/discussions/192970), so we
57+
compute the statistics ourselves by cloning each repository locally and
58+
tallying lines changed with the `git` CLI
59+
- Our computed totals likely under-count relative to GitHub's, since theirs
60+
correctly attribute authorship for contributions to pull requests with
61+
several authors that end up squashed and merged by just one author
5062
- Repository view count statistics often seem too low, and many referring sites
5163
are not captured
5264
- If you lack permissions to access the view count for a repository, it will
5365
be tallied as zero views – this is common for external repositories where
5466
your only contribution is making a pull request
55-
- Total lines of code modified may be inflated – GitHub counts changes to files like
56-
`package-lock.json` that may impact the line count in surprising ways
57-
- On the other hand, GitHub refuses to count lines of code for repositories
58-
with more than 10,000 commits, so contributions to those will not be
59-
reflected in the data at all
6067
- Only repositories with commit contributions are counted, so if you only open
6168
an issue on a repo, it will not show up in the statistics
6269
- Repos you created and own may not be counted if you never commit to them, or
6370
if the committer email is not connected to your GitHub account
64-
- [The GitHub API endpoint for computing contributor statistics no longer works
65-
reliably](https://github.com/orgs/community/discussions/192970), so we compute
66-
the statistics ourselves by cloning each repository locally and tallying lines
67-
changed with the `git` CLI
68-
- Our computed totals likely under-count relative to GitHub's, since theirs
69-
correctly attribute authorship for contributions to pull requests with
70-
several authors that end up squashed and merged by just one author
7171

7272
If the calculated numbers seem strange, run the CLI locally and dump JSON output
7373
to determine which repositories are skewing the statistics in unexpected ways.

0 commit comments

Comments
 (0)