diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..793b80b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing +We love pull requests from everyone. Any contribution is valuable! + +If you have some time and are interested in working on some issues please have a look at the list of issues and browse the ones labelled good-first-issues. Feel free to propose your own issues as well! + +## Making a change + +Make your changes to the codebase. We recommend using TDD. Add a test, make changes and get the test suite back to green. + +Once the tests are passing you can commit your changes. + + git add . + git commit -m "Add a concise commit message describing your change here" + +Push your changes to a branch on your fork: + + git push origin branch-name-here + +## Submitting a Pull Request + +Use the GitHub UI to submit a new pull request against upstream/master. + +Please ensure that you: +* Write tests +* Make sure the whole test suite is passing +* Keep your PR small, with a single focus +* Maintain a clean commit history +* Use a style consistent with the rest of the codebase +* Before submitting, rebase on the current master branch