Skip to content

mntnr/awesome-contributing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Awesome-Contributing Awesome

Awesome contributing guides for open source development.

Examples

Templates

The @Contribute-md Template is detailed and cohesive, and should work for most projects.

We All Contribute is a JavaScript CLI tool that can help you create Contribute files according to their guidelines.

Guides to writing a Contribute.md document

GitHub guide here and here are useful. GitHub automatically opens up a banner pointing to a Contribute.md file. This means that anyone who opens an issue or a pull request will know to check your Contributing guidelines. Newcomers will be the main target - experienced users will have memorized anything in your Contribute, and won't need it to guide them. Because of this, you want to make sure it is as accessible as possible.

MozillaScience's guide goes into depth about what to put into this guide, and is the best guide we've seen for how to write contributing docs in general.

Contribute

We encourage all contributions to this repository! Open an issue! Or open a Pull Request!

Note: All interaction here should conform to the Code of Conduct.

License

CC0

To the extent possible under law, Richard Littauer has waived all copyright and related or neighboring rights to this work.