Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjdenio/contributor_list
Easily list contributors on your README!
https://github.com/cjdenio/contributor_list
Last synced: 29 days ago
JSON representation
Easily list contributors on your README!
- Host: GitHub
- URL: https://github.com/cjdenio/contributor_list
- Owner: cjdenio
- License: gpl-3.0
- Created: 2020-07-14T14:33:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-22T15:21:29.000Z (over 3 years ago)
- Last Synced: 2024-12-20T07:07:30.619Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 111 KB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hackclub - Contributor List - [@cjdenio](https://github.com/cjdenio) - **(Python)** _👥 Easily list contributors on your README!_ (GitHub Actions)
- jimsghstars - cjdenio/contributor_list - Easily list contributors on your README! (Python)
README
# 👥 Contributor List
GitHub Action to easily list contributors on your README!
## 🏁 Getting Started
In your repository, create a file named `contributor_list.yml` under `.github/workflows/`.
Paste the following content into it:
```yml
name: Contributor List
on:
push:
branches:
- master
jobs:
contributor_list:
name: Contributor List
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: docker://cjdenio/contributor_list:latest
```
Push to the repo, and your contributor list has been created! 🎉
## ↕️ Moving the contributor list
Don't want it at the end of the README? That's OK! Just move it to the place you'd like. **Make sure you move the two `` comments along with it!**
## 📝 Writing a custom template
Don't like the default look? You can write a custom [Jinja](https://jinja.palletsprojects.com/) template, then place it in the `.github/contributor_list_template.md` file. [Here's the default one](https://raw.githubusercontent.com/cjdenio/contributor_list/master/contributor_list/default_template.md), for inspiration.
`contributors` is an array that looks like this (already sorted by number of contributions, by the way):
```json
[
{
"login": "octocat",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"html_url": "https://github.com/octocat",
"contributions": 32
}
]
```
## ⚙️ Configuration
You can customize your contributor list with various options! Below is an example: (they're all optional, by the way)
```yaml
name: Contributor List
on:
push:
branches:
- master
jobs:
contributor_list:
name: Contributor List
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: docker://cjdenio/contributor_list:latest
with:
commit_message: 📝 Update contributors list
# Max number of contributors to display on the README
max_contributors: 5 # Default: 10
# This enables showing contribution numbers on the README.
# ⚠️ THIS WILL PUSH TO THE REPO AFTER EVERY COMMIT ⚠️
show_numbers: true # Default: false
# Markdown heading level for the contributors section
header_level: 3 # Default: 2
```
## 🐛 Known Issues
- [**Contributor List won't work if your default branch is protected.**](https://github.com/cjdenio/contributor_list/issues/6)
## 👥 Contributors
- **[@cjdenio](https://github.com/cjdenio)**
- **[@gleich](https://github.com/gleich)**