Add contributors list

[powerzbt]

Categorize the contributions of contributors in a way that supports and encourages further contributions.

[huybery]

Is there a way to automate this update?

[rbren]

+1 love the idea, but we should have a script to keep it updated

[rbren]

@powerzbt how did you generate this?

[powerzbt]

+1 love the idea, but we should have a script to keep it updated

I am working on this. thank you for your vote.

[powerzbt]

@powerzbt how did you generate this?

Based on contributor's commit history

[rbren]

ahh you wrote it by hand? 👍

[powerzbt]

ahh you wrote it by hand? 👍

yeah 🥹

[PierrunoYT]

I don't really know how to do this but I think you can do it with Github Actions.

Here is a summary of the key points:

To effectively manage and recognize contributors in a GitHub repository, the following approaches can be used:

1. Automation using GitHub Actions:

   • Create a workflow file to automatically update the contributors list when new contributions are made.
   • Utilize pre-built actions like "all-contributors" to list and categorize contributors.

2. Categorizing contributions:

   • Use the "All Contributors" specification to recognize contributions across different categories (e.g., code, documentation, design).
   • Leverage the "all-contributors" bot or action to maintain the categorization automatically.

3. Custom script for updating the contributors list:

   • Write a script that uses the GitHub API to retrieve the list of contributors and their contributions.
   • Update the contributors list in a file (e.g., CONTRIBUTORS.md) based on your categorization logic.
   • Integrate the script into a GitHub Actions workflow.

4. Encouraging further contributions:

   • Ensure the contributors list is prominently displayed in the project (e.g., in the README.md file) to show appreciation.
   • Consider including personalized acknowledgments or highlights for special contributions in project updates or newsletters.

The key benefits of these approaches are to save time, keep the recognition of contributors up-to-date, and foster a culture of appreciation and engagement within the project community.

[rbren]

There are a handful of utilities out there that automate this, e.g. https://github.com/mgechev/github-contributors-list

I think we just need to pick one and integrate it. Even if someone needs to run it by hand occasionally. But e.g. a github action that runs nightly would be 🥇

[rbren]

@powerzbt I'm going to close this, but if you find a way to automate it let us know!