How can an open source project get volunteer contributors to document their contribution properly?
We've got an open source project with a scripting interface. Gradually we are adding more and more script bindings to it. Obviously, users can only use our script bindings when they know they exist and what they do.
For that reason I did this:
- I launched a sub-section on our wiki to document script bindings
- I created a documentation template for script bindings on the wiki
- I documented all the script bindings I made and a few I did not make using said template.
- I added a comment to the source file where all script bindings need to be declared
// When you add a script binding, remember to document it on https://wiki.example.org/scripting
- When a developer pushed a change adding a script binding, I told them on our IRC channel
Thank you for your commit. Remember to document your new script binding on https://wiki.example.org/scripting. Usual answer:
Yeah, yeah, I'll do it whenever I have time. Usually they don't.
- When one of the users I support complains about the lack of documentation, I forward said complaint to whoever made the binding or to the IRC channel in general.
None of that really helped. The majority of our script bindings are still undocumented. What else can I do to get people to document their work properly?