You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
; Token requires the `public_repo` and `read:user` scopes.
41
+
; This provider tracks all contributors to a specific repository.
40
42
CONTRIBKIT_GITHUB_CONTRIBUTORS_TOKEN=
41
43
CONTRIBKIT_GITHUB_CONTRIBUTORS_LOGIN=
42
44
CONTRIBKIT_GITHUB_CONTRIBUTORS_MIN=1
43
45
CONTRIBKIT_GITHUB_CONTRIBUTORS_REPO=
44
46
47
+
; GitHubContributions provider.
48
+
; Token requires the `read:user` scope.
49
+
; This provider aggregates merged pull requests across all repositories by repository owner (user or organization).
50
+
; Each owner appears once with the total merged PRs you authored to their repos.
51
+
; Avatar and link point to the owner (or to the repo if only one repo per owner).
52
+
; Only merged PRs are counted - open or closed-without-merge PRs are excluded.
53
+
CONTRIBKIT_GITHUB_CONTRIBUTIONS_TOKEN=
54
+
CONTRIBKIT_GITHUB_CONTRIBUTIONS_LOGIN=
55
+
; Optional: Cap the maximum contribution count per org/user (useful for circles visualization)
56
+
CONTRIBKIT_GITHUB_CONTRIBUTIONS_MAX=
57
+
; Optional: Apply logarithmic scaling to reduce dominance of high contributors (true/false)
58
+
CONTRIBKIT_GITHUB_CONTRIBUTIONS_LOGARITHMIC=
59
+
45
60
; GitlabContributors provider.
46
61
; Token requires the `read_api` and `read_user` scopes.
47
62
CONTRIBKIT_GITLAB_CONTRIBUTORS_TOKEN=
@@ -96,9 +111,26 @@ CONTRIBKIT_LIBERAPAY_LOGIN=
96
111
> This will require different env variables to be set for each provider, and to be created from separate
97
112
> commands.
98
113
114
+
#### GitHub Provider Options
115
+
116
+
There are two GitHub contributor providers available:
117
+
118
+
-**GitHubContributors**: Tracks all contributors to a specific repository (e.g., `owner/repo`). Each contributor appears once with their actual contribution count to that repository.
119
+
-**GitHubContributions**: Aggregates a single user's **merged pull requests** across all repositories, grouped by repository owner (user or organization). Each owner appears once with the total merged PRs. The avatar and link point to the owner (or to the specific repo if only one repo per owner).
120
+
121
+
Use **GitHubContributors** when you want to showcase everyone who has contributed to your project with their contribution counts.
122
+
Use **GitHubContributions** when you want to understand where a single user's completed contributions (merged PRs) have gone, without overwhelming duplicates per repo under the same owner.
123
+
124
+
**GitHubContributions accuracy**:
125
+
- Counts only **merged** pull requests - open or closed-without-merge PRs are excluded
126
+
- Discovers repos via **2 sources**:
127
+
1.**contributionsCollection** - Yearly commit timeline (full history) for discovering repositories you have committed to
128
+
2.**Search API** - Repositories where you have merged PRs (`is:pr is:merged author:login`)
129
+
- When an owner has only one repo, the link points to that repo; otherwise to the owner profile
0 commit comments