Skip to content

Commit

Permalink
Update README on counting contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
j3soon committed Jul 12, 2024
1 parent 77cb3ec commit f09b170
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ unless you access private repositories.

For private GitHub repositories, you only need to allow read-only access to `Contents` and `Metadata` on the target repository. This could be done by setting `Read-only` access of `Permissions > Repository permissions > Contents`.

## Counting Contributors

* In GitHub repositories, the commit authors, [committers](https://stackoverflow.com/a/18754896), and [co-authors](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors) are counted as contributors. However, the plugin requires a GitHub token to fetch the list of co-authors. If co-authors exist but no token is provided, the plugin will show a warning and will only display the commit authors and committers.
* In GitLab repositories, only the commit authors are counted as contributors.

## Config

- `enabled` - Disables plugin if set to `False` for e.g. local builds (default: `True`)
Expand Down

0 comments on commit f09b170

Please sign in to comment.