Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mntnr/awesome-contributing

Awesome contributing guides for open source development.
https://github.com/mntnr/awesome-contributing

List: awesome-contributing

awesome awesome-list community contribute contributing github guides

Last synced: 5 days ago
JSON representation

Awesome contributing guides for open source development.

Awesome Lists containing this project

README 

        
# Awesome-Contributing [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)



> Awesome contributing guides for open source development.



## Examples



- [atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) _An extensive Contributing guide that is particularly good at answering questions by new users before they know enough to ask them._ - [@RichardLitt](https://github.com/RichardLitt)

- [Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md) _Docker got everything right. Grats even from a non-addict, this is a very good contrib guide._ - [@FlorianHeigl](https://github.com/FlorianHeigl)

- [Pacote](https://github.com/zkat/pacote/blob/latest/CONTRIBUTING.md) _This is a pretty awesome example of a contributing file._ - [@dignifiedquire](https://github.com/dignifiedquire)

- [Puppet](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md) _A very accessible guide. The additional resources list is especially helpful_. - [@RichardLitt](https://github.com/RichardLitt)

- [Rust Programming Language](https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md) _A very complete contributing guide._ - [@sirodoht](https://github.com/sirodoht)

- [donet/corefix](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/contributing.md) _A short and concise contributing file._ - [@jzeferino](https://github.com/jzeferino)



## Templates



The [@Contribute-md Template](https://github.com/contribute-md/contribute-md-template) is detailed and cohesive, and should work for most projects.



[We All Contribute](https://github.com/WeAllJS/weallcontribute) 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](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) and [here](https://github.com/blog/1184-contributing-guidelines) are useful. GitHub [automatically opens](https://github.com/blog/1184-contributing-guidelines) 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](https://mozillascience.github.io/working-open-workshop/contributing/) 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!](https://github.com/RichardLitt/awesome-contribute) Or open a Pull Request!



Note: All interaction here should conform to the [Code of Conduct](CODE_OF_CONDUCT.md).



## License



[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](https://creativecommons.org/publicdomain/zero/1.0/)



To the extent possible under law, [Richard Littauer](https://burntfen.com) has waived all copyright and related or neighboring rights to this work.