Do You Tell People How To Get Involved with your Project?
  v1.0 Posted at 29/03/2016 8:46 AM by Tiago Araujo

The key to building a great open source project is to build a great community around your project.

To do this it is essential that potential contributors can find out how to get involved.​

​​It is a common pattern for open source projects to contain a CONTRIBUTING.md markdown file that supplies information on how to get involved.​​

Figure: Good Example - The Microsoft ASP.NET and Azure teams both do a great job of providing documentation on how to start contributing
Figure: Good Example - The ASP.NET team (and the SSW team) use a common CONTRIBUTING.md in a common 'Home' repository. This ensures that all projects for their team are collaborated on in the same way

Related rules

    Do you feel this rule needs an update?

    If you want to be notified when this rule is updated, please enter your email address:


    Note: Social Media login for Yotpo is not working in IE or Safari, please use Chrome. We are waiting for Yotpo to fix it.