This project iterates through your entire Github organization and builds a contributors page. Much like https://contributors.chatwoot.com. You can set up a contributors page for your organization quickly.
GitHub Actions is used to pull the commits and create the contributor database.
- Every 6 hours, a workflow fetches the latest commits from all the repositories and updates the contributor/commit data.
- This information is committed back to the repository.
- A leaderboard based on the commit history is created automatically.
Publishing the page is automated using Github Actions.
- Every time a commit is done on the
masterbranch, the gh-pages workflow would run, and the branchgh-pageswould be updated.
- Create a repository from this template.
- Update the
contributors.config.jsfile in the repository as follows.
| Key | Description |
|---|---|
| basePath | If you are hosting the page on Github pages without a custom domain, you would need to configure this to the name of your repository. eg: '/contributors-page' |
| projectName | This can be your brand name, project name etc. |
| siteMetadata.title | This title field is used as the title in the generated webpage |
| pageTitle | Share the title to be shown on the page. eg: 'We thank all our contributors' |
| pageDescription | Along with the title, you can use the description if you want to show gratitude to the community. e.g., Chatwoot would not have been what it is today without the help of our amazing contributors. |
| githubLink | Link to your Github Repo / Organization |
| contributingGuide | Link to your documentation on how someone can contribute to the page |
| sponsorsLink | If you have a Github sponsor/other sponsor pages, you can link here |
| github.org | Use the organization name you want to include on the contributors page |
| github.repoNames | List the repositories you want to include while creating the contributors page. eg: [chatwoot,chatwoot-mobile-app,charts,docs] |