point out "good first issue" label
This commit is contained in:
Matthias
parent
cc3d05488b
commit
b41633cfe3
|
|
@ -2,50 +2,52 @@
|
|||
|
||||
## 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!
|
||||
|
||||
Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/good%20first%20issue) can be good first contributions, and will help get you familiar with the codebase.
|
||||
|
||||
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).
|
||||
- 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/freqtrade/freqtrade/issues) before a PR.
|
||||
|
||||
**Before sending the PR:**
|
||||
## Before sending the PR:
|
||||
|
||||
## 1. Run unit tests
|
||||
### 1. 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
|
||||
#### Test the whole project
|
||||
|
||||
```bash
|
||||
pytest freqtrade
|
||||
```
|
||||
|
||||
### Test only one file
|
||||
#### Test only one file
|
||||
|
||||
```bash
|
||||
pytest freqtrade/tests/test_<file_name>.py
|
||||
```
|
||||
|
||||
### Test only one method from one file
|
||||
#### Test only one method from one file
|
||||
|
||||
```bash
|
||||
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
|
||||
#### Install packages
|
||||
|
||||
```bash
|
||||
pip3.6 install flake8 coveralls
|
||||
```
|
||||
|
||||
### Run Flake8
|
||||
#### Run Flake8
|
||||
|
||||
```bash
|
||||
flake8 freqtrade
|
||||
|
|
@ -56,15 +58,15 @@ To help with that, we encourage you to install the git pre-commit
|
|||
hook that will warn you when you try to commit code that fails these checks.
|
||||
Guide for installing them is [here](http://flake8.pycqa.org/en/latest/user/using-hooks.html).
|
||||
|
||||
## 3. Test if all type-hints are correct
|
||||
### 3. Test if all type-hints are correct
|
||||
|
||||
### Install packages
|
||||
#### Install packages
|
||||
|
||||
``` bash
|
||||
pip3.6 install mypy
|
||||
```
|
||||
|
||||
### Run mypy
|
||||
#### Run mypy
|
||||
|
||||
``` bash
|
||||
mypy freqtrade
|
||||
|
|
|
|||
|
|
@ -62,6 +62,7 @@ hesitate to read the source code and understand the mechanism of this bot.
|
|||
- [Requirements](#requirements)
|
||||
- [Min hardware required](#min-hardware-required)
|
||||
- [Software requirements](#software-requirements)
|
||||
- [Wanna help?]
|
||||
|
||||
|
||||
## Quick start
|
||||
|
|
@ -189,11 +190,15 @@ in the bug reports.
|
|||
|
||||
### [Pull Requests](https://github.com/freqtrade/freqtrade/pulls)
|
||||
|
||||
Feel like our bot is missing a feature? We welcome your pull requests!
|
||||
Feel like our bot is missing a feature? We welcome your pull requests!
|
||||
|
||||
Please read our
|
||||
[Contributing document](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md)
|
||||
to understand the requirements before sending your pull-requests.
|
||||
|
||||
Coding is not a neccessity to contribute - maybe start with improving our documentation?
|
||||
Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/good%20first%20issue) can be good first contributions, and will help get you familiar with the codebase.
|
||||
|
||||
**Note** before starting any major new feature work, *please open an issue describing what you are planning to do* or talk to us on [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE). This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.
|
||||
|
||||
**Important:** Always create your PR against the `develop` branch, not `master`.
|
||||
|
|
@ -218,3 +223,4 @@ To run this bot we recommend you a cloud instance with a minimum of:
|
|||
- [TA-Lib](https://mrjbq7.github.io/ta-lib/install.html)
|
||||
- [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) (Recommended)
|
||||
- [Docker](https://www.docker.com/products/docker) (Recommended)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue