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

Follow all-contributors specification in README.md #152

Open
meliache opened this issue Nov 12, 2021 · 0 comments
Open

Follow all-contributors specification in README.md #152

meliache opened this issue Nov 12, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@meliache
Copy link
Collaborator

See the all-contributors specification on github.

We put all (even single-commit) contributors into our the team section on the sphinx documentation anyway, but having them in the README seems to be more conventional and might offer additional visibility for contributors.

The all-contributors project even comes with a bot for adding contributors. Today I contributed to scikit-hep hist and got added by their contributors bot, which is how I learned about that specification.

It would be nice if we could somehow generate the sphinx contributors docs from the same source, otherwise we just might shorten that and add link to the readme for that.

@meliache meliache added the enhancement New feature or request label Nov 12, 2021
@meliache meliache self-assigned this Nov 12, 2021
@meliache meliache changed the title Follow [all-contributors](https://github.com/all-contributors/all-contributors) specification in README.md Follow _all-contributors_ specification in README.md Nov 12, 2021
@meliache meliache changed the title Follow _all-contributors_ specification in README.md Follow *all-contributors* specification in README.md Nov 12, 2021
@meliache meliache changed the title Follow *all-contributors* specification in README.md Follow all-contributors specification in README.md Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant