Files
openfoodnetwork/CONTRIBUTING.md
Lynne 29e2886b05 Update contributing.md
Include link to discourse post: How to raise a github issue
2017-05-03 11:50:07 +01:00

37 lines
1.1 KiB
Markdown

See this here post on raising a github issue:
https://community.openfoodnetwork.org/t/how-to-raise-a-github-issue/912
# Contributing
We love pull requests from everyone. Here are some instructions for
contributing code to Open Food Network. See the [developer wiki](https://github.com/openfoodfoundation/openfoodnetwork/wiki) for more information.
Fork, then clone the repo:
git clone git@github.com:your-username/openfoodnetwork.git
Follow the instructions in README.markdown to set up your machine.
Make sure the tests pass:
rspec spec
Make your change. Add tests for your change. Make the tests pass:
rspec spec
Push to your fork and [submit a pull request][pr].
[pr]: https://github.com/openfoodfoundation/openfoodnetwork/compare/
At this point you're waiting on us. We may suggest some changes or
improvements or alternatives.
To increase the chance that your pull request is swiftly accepted:
* Write tests
* Use a style consistent with the rest of the codebase
* Before submitting, [rebase your work][rebase] on the current master branch
[rebase]: https://www.atlassian.com/git/tutorials/merging-vs-rebasing/workflow-walkthrough