From 11585f958185f2645fd22593b88abd7bfb20e817 Mon Sep 17 00:00:00 2001 From: Janne Sinivirta Date: Fri, 22 Dec 2017 14:29:31 +0200 Subject: [PATCH] Create contribution guideline --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e8b0684e9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +Feel like our bot is missing a feature? We welcome your pull requests! Few pointers for contributions: + +- Create your PR against the `develop` branch, not `master`. +- New features need to contain unit tests and must be PEP8 conformant (max-line-length = 100). + +If you are unsure, discuss the feature on our [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE) +or in a [issue](https://github.com/gcarq/freqtrade/issues) before a PR. + +Before sending the PR: + +## Run unit tests + +All unit tests must pass. If a unit test is broken, change your code to make it pass. It means you have introduced a regression + +**Test the whole project** +```bash +pytest freqtrade +``` + +**Test only one file** +```bash +pytest freqtrade/tests/test_.py +``` + +**Test only one method from one file** +```bash +pytest freqtrade/tests/test_.py:test_ +``` +## Test if your code is PEP8 compliant +**Install packages** (If not already installed) +```bash +pip3.6 install flake8 coveralls +``` +**Run Flake8** +```bash +flake8 freqtrade +``` + +