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.

• Part 1 (Below): CONTRIBUTING File
• Part 2: TODO File
• Part 3: CODE_OF_CONDUCT File
• Part 4: Contributor Credit
• Part 5 (Future): BONUS TIPS!

Continue reading →