I just saw a github blog post about contributing guidelines. If you place a CONTRIBUTING.txt (or .rst, or .md etc) in the root of your github repository, github will show a link to that file when someone adds an issue to the bug tracker (or when opening a pull request).
Seems like a reasonable suggestion! So I tried it out in one of my open source projects.
My main goals:
So... this is my first try. Do you’ve got comments or tips? Do you think github’s idea is handy?
My name is Reinout van Rees and I work a lot with Python (programming language) and Django (website framework). I live in The Netherlands and I'm happily married to Annie van Rees-Kooiman.
Most of my website content is in my weblog. You can keep up to date by subscribing to the automatic feeds (for instance with Google reader):