all-contributors / all-contributors

✨ Recognize all contributors, not just the ones who push code ✨

Call for translators! We're looking for translators to help translate this spec for everyone!

Read this documentation in the following languages

한국어	中文	Bahasa Indonesia	Deutsch	Polski
English	Português do Brasil	Español	Français	Русский	日本語

This is a specification for recognizing contributors to an open-source project in a way that rewards every contribution, not just code.

The basic idea is this:

Use the project README (or another prominent public documentation page in the project) to recognize the contributions of members of the project community.

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).

The All Contributors Table

Below is an example of how using the all-contributors spec table can recognize all contributors

You can use the @all-contributors bot 🤖 to automate acknowledging contributors to your open source projects

Specification

The specification is detailed on allcontributors.org

Emoji key

The Emoji Key ✨ (and Contribution Types) can be found on allcontributors.org

Contributing

If you've ever wanted to contribute to open source, and a great cause, now is your chance!

See the contributing docs for more information

Contributors ✨

Thanks go to these wonderful people (emoji key):

Kent C. Dodds 💬 📖 👀 📢	Jeroen Engels 📖 👀 🔧	Jake Bolam 📖 🔧 🚇 🚧 👀 💬	Tyler Benning 🚧 💻 🎨	Jeff Wen 🚧 👀	Maximilian Berkmann 🌍 📖 🚧 👀 📢	Matheus Rocha Vieira 🌍 💻 📖
Robert Lluberes 🌍	이종진 📖 🌍	Wenqing Xue 🌍	Divjot Singh 📖 👀	Ben Briggs 📖 👀	James Monger 📖	Chris Simpkins 📖 👀
F. Hemberger 📖	Daniel Kraft 📖	Mayank Badola 📖 🔧	Marco Biedermann 🎨	Itai Steinherz 📖	Patrick Connolly 📖	Nikola Đuza 📖
Demian Dekoninck 💻	Michael Peyper 📖	David Sima 📖 🌍	allcontributors[bot] 📖	Greenkeeper[bot] 🚇	Maryam Pazirandeh 📖	Cassandra Venere 📖
codimiracle 📖	Sung Kim 🌍 📖	Thomas Brok 🌍	robertgrzonka 🌍	Megumi Aliya 🌍	Yule 🌍	Sylvain Pace 🔌
Peter Hürlimann 🌍	Thiago Delgado Pinto 🌍	Rogerio Prado de Jesus 🌍	Tobias Andersen 🌍	danielbronder 🌍	João Pedro Raskopf 🌍	Edwin Vargas 🌍
Faisal KANOUT 🌍	John Murphy 📖	Kirstie Whitaker 🤔	Patryk Peas 📖 🌍 💻	Ivan.Nginx 🌍	levy 📖	nils måsén 📖
Masato Urai (@uraway_) 🌍	Kyle Holmberg 📖	Simon Aronsson 🌍	Cem 🌍	Jérémie Astor 📖	Rachel M. Carmena 🌍	SnO₂WMaN 📖
César Richard 📖 📓	kharaone 📖	Mudassar Ali 📖	Andrew Mason 📖	Mauro M. 📖	Nicolas Goutay 📖	William Entriken 💻
Amine 📖	Stefano Moia 📖	Adam Tuttle 📖	Moni 🚇	Ilaï Deutel 📖	Hendrik Brummermann 📖	Sang Lostrie 🐛
xinbenlv 📖	Ivan Paulovich 📖	Jake Wiesler 📖	Micael Jarniac 🐛	Markus Löning 📖	Austin Huang 📖	Nils Andresen 📖
LaChapeliere 📖	Michal 🌍	Ali Torki 📖	Josh Soref 📖	Taiizor 💻	Ikko Ashimine 📖	Matthew 📖
Cornelius Roemer 🎨	JohnnySD 🖋 📖	mwaitzman 📖	Kenichi Kamiya 📖	Angel Aviel Domaoan 📖 💻 🚧 🐛 👀	Allan Bowe 📖	E - Coders (Aasheesh Agarwal) 📖
Fernando 📖	Vedant Mohan Goyal 📖	Muhammad Hanis Irfan Mohd Zaid 📖	Abe Hanoka 📖	Roshan Jossy 📖 💻	Sébastien Lavoie 🐛	Nicolas Girondi 🌍
Federico Grandi 📖	Henry Bley-Vroman 📖	LBF38 📖	Yoon Hyeseong 🐛

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE

MIT

all-contributors's Issues

Add Emoji for Infrastructure work

First off: love the idea/project. I am currently implementing it for [a project of mine], and even though it is with 4 contributors still quite small, already found myself with a few rather odd places with the emoji. I will post them as separate issue so we can discuss each suggestion I have.

This one is about "infrastructure work" someone might contributed. In my case this means setting up build-services (like travis), hosting, maintain servers etc. I suggest to use the "power plug" emoji: 🔌

(One could argue that this could be merged with "tools" but then we should adapt the language for that one to explicitly include that sort of thing)

When to update contributor list

Is there any guidelines on when the list should be updated?

For example, I'd someone raises an issue and a maintainer agrees that it is a bug, I would then deem the user to be a contributor.

Should they be added to the list:

• Immediately?
  • As a PR?
• When the bug is fixed?
• On next commit?
  • Could put some kind of hook in?
• On next release?

I'm committed to including the all-contributors spec in my projects, but I want to ensure I'm doing it right.

Use CONTRIBUTORS.md instead of README.md

People are giving of themselves and their free time to contribute to open source projects in so many ways. It can be a real time sink sometimes and so they should be praised for all their contributions (code or not).

+1 I completely agree.

For projects with a small number of contributors, this will work well under a Contributors heading on a README page. For larger, very active projects where hundreds (or more) individuals might meet these criteria, this list will be far too large to include on a project README.md file. I'd recommend that you consider spec'ing a separate CONTRIBUTORS.md page dedicated to these acknowledgments and a link to this page from the project README file.

Alt category text when user hovers over Contribution Category emoji icon

Maybe a built in key for the emoji by including alt text that specifies the category that it represents?

New emoji for "data" or "content"?

For many projects that also involve a live website, part of the project that may be within scope of the developer community is "data" or more generally "content". Yes, on some types of website, the "content" category could be so large and organic that it's not useful to have it in README, but for others, it might be a group small enough that they deserve special recognition among other contributors.

For example, the edgi-govdata-archiving/web-monitoring project is building out a pipeline for monitoring government webpage changes, and funneling the important changes past domain experts and to media partners. We have whole classes of contributors who aggregate and manage the list of webpages to monitor, and also the non-technical analysts who help us sort through the noise.

I would be nice to use all-contributors to recognize how these folks contribute to the project, but the current categories don't seem to fit.

Potential emoji: 🔢

Ensure site works in all major browsers

Mobile alignment

Just looked at the readme on my mobile (Nexus 5) and the tables look pretty badly aligned.

Not sure if this is something we can fix, though?

The translation README.md dose not update contributors.

The translation readme does not have links to other countries, and the contributors are not updated.

Update User Icons

I might be missing something, and if so, I apologize. Is there a way to update a member with adding new icons? I don't want to have to go into the markdown and figure out what icon needs to be added if the user has contributed more in another category. I hope this makes sense in how I am explaining it.

Do not use dynamic version hover translated version

Please remove the dynamic use of the emoji table version, this has been implemented to show that the translation is outdated or not from the original version. As you can see in the portuguese version of brazil https://github.com/all-contributors/all-contributors/blob/master/docs/en/README.md#tabela-de-emoji-v270 the table version is in 2.7 and the project in 2.7.1 which means that something is missing. Thus facilitating the life of the translators.

Documentation icon linking to commits

The documentation icon on the three contributors in README.md links to commits by that user. The info in README.md doesn't explain this, as the field next to Documentation is empty.

Spanish User test Translate

Internacionalization

Any ideia how to implement a internacionalization at this doc?

How to change the mark icon in map

How to change the mark icon in map

New possible contribution type? "Planning" / "API Design" (or something)?

Hi there! This project is really cool – nice work @kentcdodds and others! I came here looking to add some contribution boxes to some of my projects, but I didn't feel that any contribution types fit exactly what I was looking for.

Frequently, I find that figuring out the best API for a library can even be more difficult and time-consuming than actually writing the code that implements the API.

Often, I'll work with the developers who will use the library to figure out what an API should be like before running off and coding it. We will have white boarding sessions, phone calls, and basically just spend a long time bike shedding about the best solution. In the end, the coding part can be a small fraction of the total time spent figuring out the problem, and often only a few of the developers involved in all of the conversations will be involved in actually coding the thing.

I'd love to recognize a contribution like this, but there's not currently a contribution type in this repository that seems to line up with this. Do you think an existing type captures this sort of contribution?

If a new type would be warranted, I'm not sure the best name for contributions like this. One idea is "API Design," but that kind of conflicts with "Design." Maybe something like "Planning"? 🤔

It's also alright if nobody else thinks that a contribution type like this makes sense. Or maybe it's just that this isn't a "contribution" in the sense that this repository is referring. That's completely alright. I just thought I'd open the issue in case anyone else feels the same way.

Thanks for reading!

Recognise designers too?

People who provide assets such as logos, iconography, or contribute to a project's visual design.

For emoji; how about this one? 🎨

There has to be a way to automate this

For github in particular, It probably could be automated from an API.

Or has anyone tried to add a shell script that parses pages like the contributor page (eg https://github.com/kentcdodds/all-contributors/graphs/contributors) that updates and replaces a contributor table at the bottom of README.md?

Maybe not. Doing it that way would be hardly foolproof, and difficult to organize.

Specification implementation examples

Perhaps as EXAMPLES.md and EXAMPLES.rst. Yeah I hate rst too but there is a PyPI cohort out there who might find it useful...

API rate limit exceeded for

Problem:

API limit hit for all contributors

yarn all-contributors check
yarn run v1.7.0
$ /code/codewatch/node_modules/.bin/all-contributors check
API rate limit exceeded for xxx.xx.xx.xxx. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Solution i'd like to see:

A way to provide a github auth token to avoid API limits.

Additional information:

See the github docs: https://developer.github.com/v3/rate_limit/

Humans Document

"
What is humans.txt?
It's an initiative for knowing the people behind a website. It's a TXT file that contains information about the different people who have contributed to building the website.

Why a TXT?
Because it's something simple and fast to create. Because it's not intrusive with the code. More often than not, the owners of the site don't like the authors signing it; they claim that doing so may make the site less efficient. By adding a txt file, you can prove your authorship (not your property) in an external, fast, easy and accessible way.

Where is it located?
In the site root. Just next to the robots.txt file.
If possible, you can also add an author tag to the of the site:
<link type="text/plain" rel="author" href="http://domain/humans.txt" />

Why should I?
You don't have to if you don't want. The only aim of this initiative is to know who the authors of the sites we visit are.

Who should I mention
Whoever you want to, provided they wish you to do so. You can mention the developer, the designer, the copywriter, the webmaster, the SEO, SEM or SMO...
As you can see, the number of people who may take part of the creation of a site can be big, so the list is almost endless.

Meta Name or humans.txt?
This is not a fight, you don't have to choose one or the other. Humans.txt is just a way to have more information about the authors of the site.

The internet is for humans
We are always saying that, but the only file we generate is one full of additional information for the searchbots: robots.txt. Then why not doing one for ourselves?

Looking for a standard
We like the things well done, and this is why we want to provide some guidelines to make the humans.txt as standard as possible. Abel Cabans set the grounds in his own humans.txt file.

But, of course, you are free to add any information you want.
"

Use custom domain or all-contributors.js.org

Motivation

all-contributors.js.org may put off projects using other languages, and all-contributors is intended for everyone!

Which domain should we use?

Context

• .js.org has better SEO and trust in the community.
• there are already a bunch of links to all-contributors.js.org on the internet, we would need to support redirects
• we own cnames all-contributors.js.org, allcontributors.com, allcontributors.org, all-contributors.com, all-contributors.org

Work in-progress

• Update app and marketplace
• Update probot listing direct
• Update CLI
• Update bot
• Enable redirect, retire old pages

General Community Outreach

I see there are a number of emoji about specific contributions done for the projects, which are about involving more people (giving a talk, writing a blog post, etc) and I like that a lot – as this is about shining light on exactly those often overlooked contributions. Yet, by making those so specific, it becomes harder to show more general communication efforts of people – like a person super responsive on the chat or organising the issues or organising user groups or other gathering events for the team and community around it – who are very often not in the spotlight despite the hours of hours they just chuck away for teh project.

I propose to have a "General Community Outreach" work emoji, that can be used as a placeholder for all the great community work done by people but not captured by the emojis so far.

maybe 👥 or the awesome 🕴️(MAN IN BUSINESS SUIT LEVITATING) or any of the thousand family icons?

Improve basic styling of documentation pages

Improve the basic styling of documentation, some improvements that could be made:

Header

• Search Bar Styling
• Search Results Styling
• Language Selection Dropdown

Footer

• The footer

Link to Portugal documentation is broken

Link to the Portuguese documentation on the file README is broken

Where are you using this?

I'm curious about the meta plans for this repo. :)

List projects that adopt all-contributors

It would be nice to have a list of those projects so people can find them more easily.

Have an emoji for issues/feature requests/discussion

We should have an emoji and a name for creating feature requests, and/or simply discussing/bikeshedding in issues and PRs.

Kinda stuck on finding a name for this (or rather, a represents value as is written in the emoji table), and I'm not too familiar with emojis either.

Any thoughts on this? :)

Add version in README.md

Given the differences that the translated documents are having from the original version, I find it noteworthy to add in the title the version that the document is in. If accepted I can provide such PR.

Project Manager

I sugest 📋 (Clipboard)

Build a bot

I think it's clear that there's interest in the all-contributors spec. There are 259 .all-contributorsrc files on GitHub!

I think that even more people would receive the gratitude they deserve if we had a bot to automate things for us. My vision is I could open an issue or even comment on an issue or pull request with something like:

Hey @AllContributorsBot, please add @soandso to contributors for answering questions and helping with docs

And magic would happen. Anyone wanna do this?!?!?!

Consolidate readme information into central place

This work has been completed on:

• https://github.com/all-contributors/all-contributors-bot
• https://github.com/all-contributors/all-contributors-cli

I believe the next step is to consolidate the specification information available in this readme. So the website becomes the single source of truth.

I think we should do this, once the website has additional languages: all-contributors/legacy-domain-landing-page#10

When a contributor changes his username, it breaks the table layout

In the case below (from ARc), Abhishek changed his username. So link and picture doesn't exist and broke the table layout.

Ensure search is only for the current language

Tweak this setting: https://github.com/all-contributors/website/blob/master/website/siteConfig.js#L51

See documentation: https://docusaurus.io/docs/en/search#docsNav

Malformed emoji-key on all translated versions

The emoji-key table on all translated versions (except for the English one) seems to split the cells with <br> into two rows resulting in having the types in a separate row than the emojis.

en

fr

Arrow keys don't seem to work in Windows 10

I have tried to use the up/down arrow keys in both PowerShell and cmd.exe and the arrow keys seem to do nothing (the green '>' doesn't move)

Consider a more explicit and simpler contributor acknowledgment workflow for project maintainers and contributors

My workflow for acknowledgment of user efforts currently includes a scan of included issue reports and pull requests with each new release, followed by an update of the project CONTRIBUTORS.md file. I attempt to link contributor GitHub accounts with their name on the CONTRIBUTORS.md page. This is a time consuming manual task for projects with a low-moderate number of contributors and I would venture to guess it is not a sustainable model for projects with large numbers of contributors who meet these criteria. My acknowledgment workflow includes far less information/modification of the contributors page than you propose here. I would consider modifying your spec to support the following:

1. encourage contributors to pull request their own information into the acknowledgment section/page that you specify
2. include an information page that explicitly defines the project specific contribution levels that meet criteria for inclusion as a contributor

This has been an issue for us in the Hack project where source code commits are a very minor component of the intellectual/design/development contributions that have occurred in the project and therefore acknowledgment of these efforts is an entirely manual process outside of the contributors list provided by GitHub. I've chosen to be very inclusive in the level of contribution necessary to be considered a project contributor because I highly value this input and it leads to modifications/improvements in the project. In my opinion, the acknowledgment is both appropriate and important for this project. If someone else were maintaining this project or a similar type of project, the criteria could be very different. IMO, a contributor is entitled to this information and I look forward to how you approach this issue as guidance for those of us who maintain open source projects.

As a project maintainer, I want to commit to the acknowledgement of, and actually acknowledge, contributions according to your specifications, but it needs to be feasible to do so when the proposal is a manual task like you suggest here. As a contributor to other projects, I want to understand the type of contribution that is necessary to be included as a project contributor and expect that contributions of my time at these levels are appropriately acknowledged. I think that you have the opportunity to try to bridge that divide here.

Kudos to you for this effort.

Call for translators

We're in the process of moving all of our documentation to a central location #142. This place is the website, and before we can complete this, we need to translate the website (coming in all-contributors/legacy-domain-landing-page#14)

If you've ever wanted to contribute and help the cause of open source, now is your chance. We need you!

We're looking for translation help for the documentation in

• Chinese (99%) - Translation Complete ✅
• Indonesian (98%) - Translation Complete ✅
• German (99%) - Translation Complete ✅
• French (100%) - Translation Complete ✅
• Korean (100%) - Translation Complete ✅
• Portuguese (100%) - Translation Complete ✅
• Spanish (100%)- Translation Complete ✅
• Japanese (100%) - Translation Complete ✅
• Russian (58%)
• Polish (56%)
  ------- Above this line is active on website (usually added to website once above 50%) -----
• Romanian (43%)
• Dutch (10%) - 38%
• Arabic (4%)
• Swedish (5%)
• Any other languages! See crowdin: https://crowdin.com/project/all-contributors

Platform-specific contribution emoji

A lot of times open source projects only support one or a few platforms and a contributor will port or add support for a previously unsupported platform. It would be cool if they could be recognized for that (usually significant) contribution.

Document how to contribute to translating

How to:

• Login to crowdin
• Translate strings
• Caveats with hidden strings and links, the xpath property see (#157)
• Proofreaders approving strings
• Deploying changes to the site
• Adding yourself to the contributor table!

Badges

Everyone loves a badge :) Link it to the contributors list?

Add category for security

Possible emoji: 🛡️

See CLI PR: all-contributors/cli#126

Minimal Version

Suggesting this repository for another project that I find interesting I came across a rather interesting idea:

"
I would actually like to see the minimal version of that list, one with only the Avatar + GitHub profile (or website) link. From my perspective, if it does not really matter if it was a bug, a PR code, a translation or some documentation, in the end it's a contribution and it should be recognized as a contributor, without all those emoji and huge avatar
"
@goenning in getfider/fider#612

What do you think? Very cool in my opinion.

Add Category for committer

Being a committer is more than just code.

This becomes especially important for repos which do fast-forward commits, as their effort does not appear in the repository, and so repository based analysis tools omit this.

e.g. PyCQA/pyflakes@9dd73ec544 is a fast-forward commit by a non-committer, merged manually by a committer. i.e. me.

Also GitHub does not provide any public way to determine who are the committers. It only shows "Contributor" / "Org member", which doesnt indicate whether someone has "Push" rights or not.

Exposing this role in the contributor registry as a separate category seems like a logical choice.

Add Maintenance in Contributor List

Contributor info change requests

I'm wondering whether the spec should describe the behavior of the maintainers when a contributor asks to change his info (let's say by submitting a PR with the updates).

For example, if I was a contributor of a given project two years ago, and want to

• change my avatar
• the url my avatar links to
• add the link to a video of a talk I made on the
• remove a link
• change my name
• remove myself from the list

Should the maintainer be "obligated" to accept such a change? Do we want the spec to have a position on this? What if there is some obscene wording/images/links in what is demanded?
Thoughts?

Call for maintainers

Hey folks,

I'm drowning in GitHub notification emails and need to lighten my load. So with heavy heart I'm picking a few projects to detach myself from and unfortunately this is one of them.

I would like to hand this project off to someone who's already been contributing to the project (I'd like to avoid another incident like this). If you would like to take ownership of this project, please let me know by emailing me at the address found on my github profile.

I'm unwatching this repository effective immediately. I'm sorry about that, but I've just been stretched too thin. Even if nobody takes up the maintenance of this project, it works well in its current form for its current users and I hope that's good enough until someone is willing to take up the mantel as maintainer.

Question-Mark is ... awkward

The big red (or black) question mark looks like something failed to load or the position of that person is questionable/unknown. Making it a very awkward emoji to use. Once you read the spec it feels like it makes sense, but when you see it in a Readme, even after that, it is just not very positive. Can't we at least use the "answered" version of that emoji: ⁉️ – or is that just no strong enough in most fonts?

Emoji title

I think it would be better when hover on some emoji on generated list of all contributors to show what that emoji means. Because currently it shows the code for emoji (for example, :eyes:), which kinda force you to navigate to the space (almost always, until you learn all of them ;d) to see what it means.

Links are being translated resulting in broken URLs

E.g. https://all-contributors.js.org/docs/zh-CN/仓库维护人员

Reformat Contributors

It's crazy long. I'm thinking of doing something like this:

Will submit a PR soon.