Following GitHub convention by adding a CONTRIBUTING.md file.

[jbranchaud]

Adding CONTRIBUTING.md with the content from the contributing page of the wiki. GitHub recognizes this file and links to it when people try to contribute to a repository. This will help ensure that people understand the contribution guidelines set out for this project before they contribute.

[flugsio]

Communicating should probably be a real link.

[jbranchaud]

@flugsio Thanks for catching that!

[tarruda]

@jbranchaud nice, could you also explain that people looking for something to do can click in the waffle.io badge to see tasks ready to be worked on? Also squash the changes into one commit

[ashleyh]

Any thoughts on keeping this in sync with the wiki? Could just delete the wiki page but that increases PR merging workload.

[jbranchaud]

@ashleyh Perhaps we just come up with some concise, standard contributing guidelines (that won't change much, if at all) and the wiki can be used for more extensive explanation and information that changes frequently.

[jbranchaud]

@tarruda I am not particularly familiar with squashing. I just read up on it and it is fairly straight-forward, but I have concerns about doing it when some commits have already been submitted as part of the pull request. Any guidance here?

[taketwo]

@jbranchaud After you are done with squashing do a push with --force flag. Assuming that the remote for your fork is called jbranchaud in your local clone you will want to do:

git push jbranchaud adding-contributing-doc --force

The old commits in this pull request will magically disappear, only the new one will be visible.

[jbranchaud]

@taketwo That really was magic, thanks!

@tarruda I updated with the waffle stuff and then squashed the commits, let me know if you need anything else before merging it.

[rjw57]

@jbranchaud thanks for this. I'll merge now. Could you update the wiki to point to CONTRIBUTING.md? That way we don't need to keep them in sync.

[rjw57]

roll eyes merge and then close @rjw57 :).