One day I was just working on my projects and then one of my college senior pinged me and asked whether there was any tool that can automate the contributor’s list in a readme. So like everyone, I googled and found out the all-contributors bot with some amazing features. It can even distinguish between various categories like design, documentation, and a lot more.
But the issue was that.
- It was not automatic. We need to put a PR to update the list. The PR’s automatic recognition system to various categories was amazing though. But still automatic would be easier for some.
- Second as it’s a bot. You need to pass a token and you need to create it and so the setup was a bit more.
So my senior just said, then build something to solve this man, it would be a lot helpful to others.
So to solve all these issues. The best option after a lot of googling was a GitHub action. Simple to set up, secure, and easy to automate. Contributors-Readme-Action can not only automate the contributor’s list it can do much more.
- It can automate
- Contributors List
- Collaborators List
- Sponsors List ( GitHub Sponsors )
- Bots List
- You can also add usernames that may be the organization’s main team which needs to be at top of the list.
- It also supports re-arrangement (obviously 😃)
The project started with a dumb setup that formed a lot of bugs and the feature set was basic. But some humble developers pointed out the issues that made the action more robust and usable. Thanking all those developers and also I am still open to new features and loves to add them.
If you have any issues with this action’s usage kindly put an issue in the repository, I would love to help you out.
If you have liked the project, star ⭐️ it for future updates and also to motivate me 😄.