Skip to content

feat(add all contributor bot)#116

Merged
Davidek523 merged 3 commits intomainfrom
add-all-contributors-config
Mar 30, 2025
Merged

feat(add all contributor bot)#116
Davidek523 merged 3 commits intomainfrom
add-all-contributors-config

Conversation

@ultimateownsz
Copy link
Collaborator

Pull Request Template

Type of Pull Request

Only check one box per pull request.

  • 🛠️ Code - Changes to the codebase.
  • 🔄 Revert - Reverts a previously merged commit or PR.
  • 📄 Documentation - Updates to documentation files.
  • 🎵 Audio - Changes to audio files.
  • 🎨 Asset - Updates to design or visual assets.

Summary

This PR adds the https://allcontributors.org/ bot to the project. "People are giving themselves and their free time to contribute to open source projects in so many ways, so we believe everyone should be praised for their contributions (code or not)." a direct quote from the documentation, this bot will help categorize what a contributor does to the project.

It's very simple to use, after this PR gets merged we can mention the bot like so:
afbeelding
When you add a certain emoji, the bot will recognize this and add that specific contribution type to the table.
The specific type of contributions can be found here: https://allcontributors.org/docs/en/emoji-key

What the bot then does is open a new PR with the new contributor's addition and saves it in the CREDITS.md file.

Note

We can not mention the bot to update the list of contributors yet, this can only be done when it's merged into the main branch.

Related Issues

This PR issue(s)


✅ Checklist:

  • Tested the changes locally.
  • Verified that no breaking changes are introduced.
  • Updated documentation (if applicable).

🏷️ Labels:

type:feature, area:tools

makes the new implementation easier with all contributor bot
add easier implementation to mention old/new contributors and saves it in the CREDITS.md file!
fix correct repoHost URL.
@ultimateownsz ultimateownsz added type:feature For introducing new features area:tools Changes to developer tools or build systems labels Mar 29, 2025
Copy link
Collaborator

@Davidek523 Davidek523 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks pretty straight forward but I dont know how can I test it?

@ultimateownsz
Copy link
Collaborator Author

You have to merge it first because the bot only can do this after the configuration is merged in the main branch.

Copy link
Collaborator

@Davidek523 Davidek523 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@Davidek523 Davidek523 merged commit 838e849 into main Mar 30, 2025
1 check passed
@ultimateownsz ultimateownsz deleted the add-all-contributors-config branch May 29, 2025 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:tools Changes to developer tools or build systems type:feature For introducing new features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments