adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

formatting for contributing.md

Browse Source
This commit is contained in:
Matthias 2018-09-12 20:24:19 +02:00
parent fadf82dd32
commit 601ae05459
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -1,15 +1,17 @@
# Contribute to freqtrade # Contributing
## Contribute to freqtrade
Feel like our bot is missing a feature? We welcome your pull requests! Few pointers for contributions: 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`. - Create your PR against the `develop` branch, not `master`.
- New features need to contain unit tests and must be PEP8 - New features need to contain unit tests and must be PEP8
conformant (max-line-length = 100). conformant (max-line-length = 100).
If you are unsure, discuss the feature on our [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE) 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/freqtrade/freqtrade/issues) before a PR. or in a [issue](https://github.com/freqtrade/freqtrade/issues) before a PR.
**Before sending the PR:** **Before sending the PR:**
## 1. Run unit tests ## 1. Run unit tests
@ -17,27 +19,34 @@ or in a [issue](https://github.com/freqtrade/freqtrade/issues) before a PR.
All unit tests must pass. If a unit test is broken, change your code to 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. make it pass. It means you have introduced a regression.
**Test the whole project** ### Test the whole project
```bash ```bash
pytest freqtrade pytest freqtrade
``` ```
**Test only one file** ### Test only one file
```bash ```bash
pytest freqtrade/tests/test_<file_name>.py pytest freqtrade/tests/test_<file_name>.py
``` ```
**Test only one method from one file** ### Test only one method from one file
```bash ```bash
pytest freqtrade/tests/test_<file_name>.py::test_<method_name> pytest freqtrade/tests/test_<file_name>.py::test_<method_name>
``` ```
## 2. Test if your code is PEP8 compliant ## 2. Test if your code is PEP8 compliant
**Install packages** (If not already installed)
### Install packages
```bash ```bash
pip3.6 install flake8 coveralls pip3.6 install flake8 coveralls
``` ```
**Run Flake8**
### Run Flake8
```bash ```bash
flake8 freqtrade flake8 freqtrade
``` ```
@ -49,13 +58,13 @@ Guide for installing them is [here](http://flake8.pycqa.org/en/latest/user/using
## 3. Test if all type-hints are correct ## 3. Test if all type-hints are correct
**Install packages** (If not already installed) ### Install packages
``` bash ``` bash
pip3.6 install mypy pip3.6 install mypy
``` ```
**Run mypy** ### Run mypy
``` bash ``` bash
mypy freqtrade mypy freqtrade