CodeforAustralia / school-finder

:eyes: Find schools by location
https://education.nsw.gov.au/school-finder
GNU General Public License v3.0
18 stars 7 forks source link

document issue and pull request guidelines in contributing doc #272

Closed techieshark closed 7 years ago

techieshark commented 7 years ago

To make it easier for others to contribute to the project, we should document what we're looking for in issue descriptions and pull requests.

If we create a CONTRIBUTING.md file, Github will include a handy link to it from the new issue page and new pull request page: https://github.com/blog/1184-contributing-guidelines

Here's a good example: https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md

A few things we might mention:

Later we could set up a lint bot to check code style etc but for now just being clear about these guidelines should help.

Lilith-Palmer commented 7 years ago

@Rustuma have you thought about this?

techieshark commented 7 years ago

I'll take a stab at this.