arumoy-shome / UWNerdist

Got free time? Check out what classes are going on at the UW campus that interest you!
MIT License
1 stars 1 forks source link

Write a CONTRIBUTING doc #10

Closed arumoy-shome closed 7 years ago

arumoy-shome commented 7 years ago

From open source guides:

A CONTRIBUTING file tells your audience how to participate in your project. For example, you might include information on:

How to file a bug report (try using issue and pull request templates) How to suggest a new feature How to set up your environment and run tests In addition to technical details, a CONTRIBUTING file is an opportunity to communicate your expectations for contributions, such as:

The types of contributions you’re looking for Your roadmap or vision for the project How contributors should (or should not) get in touch with you