Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🫂 Implement the All Contributors Specification #77

Open
2 tasks done
KagemniKarimu opened this issue Dec 9, 2024 · 1 comment
Open
2 tasks done

🫂 Implement the All Contributors Specification #77

KagemniKarimu opened this issue Dec 9, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@KagemniKarimu
Copy link
Contributor

Self Checks

Provide a description of requested docs changes

Recommendation

⭐ All Contributors voices are valued. We should implement the All Contributors spec to give shine to people who have given themselves in other ways besides code: https://allcontributors.org/docs/en/overview

From the website:

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). Projects should define contributors as those who contribute to a project in any of the Contribution Categories at any level of contribution. This specification is, by definition, inclusive of all contributions.

Implementation

The easiest way to do it is via the All Contributors bot.
https://allcontributors.org/docs/en/bot/installation

Broad steps

  1. Install the GitHub App
  2. Allow Permissions
  3. Edit README.md to fit bot parsing :
## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
  1. Add Badge to README.md:
[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)

(Adjust color & style to match other shields)

  1. Create a new file: .all-contributorsrc , optionally importing current contributors. Necessary for the bot to function.
{
  "projectName": "<insert the repo's name>",
  "projectOwner": "<insert the repo's owner/orgs>"
}
  1. Update our Contributor.md to explain how the bot works/how contributions are counted.
@KagemniKarimu KagemniKarimu added the documentation Improvements or additions to documentation label Dec 9, 2024
@Liquidwe
Copy link
Member

Yes, we take Contributors very seriously, and the repository currently has a simple version of bot:https://github.com/chainbase-labs/manuscript-core/blob/main/.github/workflows/contribute.yml

@KagemniKarimu KagemniKarimu changed the title Implement the All Contributors Specification 🫂 Implement the All Contributors Specification Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants