This is Part 3 of a 5 part series. Links to other parts (as they become available) are below.
We’ve previously talked about adding the CONTRIBUTING and TODO files, so now we’ll get to the post I’ve been dreading: the CODE_OF_CONDUCT file. I believe strongly in the value of codes of conduct, and think every project should have one.
So, why would I dread it?
This is Part 2 of a 5 part series. Links to other parts (as they become available) are below.
So, you’ve added a CONTRIBUTING file to your module (in part 1). That’s great! Now people know the ground rules for contributing to your module. But there is another thing you can do to encourage the contributions you want: Simply tell the potential developer what changes you might appreciate.
You’ve written something awesome! You want to release it as open source software into the world. And, you hope other people will want to polish the rough edges, oil the squeaking hinge, and translate the help text into Klingon. Assuming that your module is interesting to people, how do you help them help you? I’ll give examples of how to do this in the context of Perl 5 modules, but they’ll work in other languages, too.
I talked about this in a lightning talk @ The Perl Conference 2018
But I also thought I could expand and organize my thoughts a bit better, so for the textually inclined, read on!
This is part one of a five part series. I’ll link them all here when they are up.