Do You Tell People How To Get Involved with your Project?

Updated by Brady Stroud [SSW] 1 year ago. See history

123

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.

Image

✅ Figure: Good Example - The Microsoft ASP.NET and Azure teams both do a great job of providing documentation on how to start contributing

Image

✅ 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

acknowledgements
related rules