Open Up Your Open Source Module – Part 4: Contributor Credit

This is Part 4 of a 5 part series.  Links to other parts (as they become available) are below.

We’ve previously talked about adding the CONTRIBUTING, TODO and CODE_OF_CONDUCT files. But how about giving contributors credit? This is a short, and easy, tip.

It’s simple: when a contributor submits something, like a PR (Pull Request) or bug report, give them credit!

Like the Contributor Covenant, if you are creating Perl 5 modules using Dist::Zilla, using the Git::Contributors plugin. Just add the following to your dist.ini file (assuming you’ve installed Dist::Zilla::Plugin::Git::Contributors):

[Git::Contributors]

Doing this will add the Git contributors to your Perl 5 module’s META.json file. This will be picked up by other tools, such as MetaCPAN, and your contributors will now show up there.

For example:
metacpan-contributors

If you want to see yourself (and you’re listed in the author section of your dist.ini), you might try this – and maybe even put the most prolific contributors first:

[Git::Contributors]
include_authors=1
order_by=commits

Whatever language you use, you’ll also want to add them to your documentation. This is pretty straight forward, but might help that first-time contributor feel appreciated – and contribute more!
they are your values to communicate.

3 thoughts on “Open Up Your Open Source Module – Part 4: Contributor Credit

  1. Pingback: Open Up Your Open Source Module – Part 1: CONTRIBUTING File | Digital Barbed Wire

  2. Pingback: Open Up Your Open Source Module – Part 2: TODO File | Digital Barbed Wire

  3. Pingback: Open Up Your Open Source Module – Part 3: CODE_OF_CONDUCT File | Digital Barbed Wire

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s