loading...
Cover image for Build the code, thank the contributors!

Build the code, thank the contributors!

spboyer profile image Shayne Boyer ・2 min read

The GitHub event announced a great new feature - GitHub Sponsors. GitHub Sponsors is a new way to financially support the developers who build the open source software you use every day. See the full announcement blog post for more information.

Recognizing Contributors

Recently, Brian Clark introduced me to all-contributors (https://github.com/all-contributors/all-contributors) an awesome way to recognize contributors to your project.

all contributors table image

The installation is super easy. Enable the bot on your repository, and you're ready to go.

Good practice is to have a CONTRIBUTING.md in your repo not only to encourage good practices but to also set expectations and standards.

add bot to repo image

Adding contributors

There are a few ways in which our contributors get added to the table on the README.

First, this is a go forward bot for contributions/commits; therefore they are added as commits happen.

For other ad-hoc acknowledgments, you may comment on a PR or Issue.

simple add example

The comment may also be a bit more intentional. Per the docs, it uses basic Natural Language Processing.

Here, I added Jen Looper for her design work.

nlp example

In either case, a PR is opened to add the user/contributor to the README and .all-contributorsrc files for the attributions.

PR image

Building community through code is at the heart of GitHub, but being a good human through good manners is the first step to continuing that effort. Say thank you to your contributors. It takes a few moments, they will thank you with more commits.

...this has been cross posted from: http://tattoocoder.com/build-the-code-thank-the-contributors/

Posted on by:

spboyer profile

Shayne Boyer

@spboyer

I work on open source in the cloud @microsoft. containers, kubernetes, .net core, nodejs, typescript

Discussion

markdown guide