Skip to content

Commit

Permalink
Improve developer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xmatthias committed Jan 21, 2019
1 parent 07577ac commit 1be3d57
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
20 changes: 4 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Few pointers for contributions:
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.

## Getting started

Best start by reading the [documentation](https://www.freqtrade.io/) to get a feel for what is possible with the bot, or head straight to the [Developer-documentation](https://www.freqtrade.io/en/latest/developer/) (WIP) which should help you getting started.

## Before sending the PR:

### 1. Run unit tests
Expand Down Expand Up @@ -41,12 +45,6 @@ pytest freqtrade/tests/test_<file_name>.py::test_<method_name>

### 2. Test if your code is PEP8 compliant

#### Install packages

```bash
pip3.6 install flake8 coveralls
```

#### Run Flake8

```bash
Expand All @@ -60,22 +58,12 @@ Guide for installing them is [here](http://flake8.pycqa.org/en/latest/user/using

### 3. Test if all type-hints are correct

#### Install packages

``` bash
pip3.6 install mypy
```

#### Run mypy

``` bash
mypy freqtrade
```

## Getting started

Best start by reading the [documentation](https://github.com/freqtrade/freqtrade/blob/develop/docs/index.md) to get a feel for what is possible with the bot, or head straight to the [Developer-documentation](https://github.com/freqtrade/freqtrade/blob/develop/docs/developer.md) (WIP) which should help you getting started.

## (Core)-Committer Guide

### Process: Pull Requests
Expand Down
14 changes: 13 additions & 1 deletion docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,20 @@ This page is intended for developers of FreqTrade, people who want to contribute

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. We [track issues](https://github.com/freqtrade/freqtrade/issues) on [GitHub](https://github.com) and also have a dev channel in [slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE) where you can ask questions.

## Documentation

## Module
Documentation is available at [https://freqtrade.io](https://www.freqtrade.io/) and needs to be provided with every new feature PR.

Special fields for the documentation (like Note boxes, ...) can be found [here](https://squidfunk.github.io/mkdocs-material/extensions/admonition/).

## Developer setup

To configure a development environment, use best use the `setup.sh` script and answer "y" when asked "Do you want to install dependencies for dev [y/N]? ".
Alternatively (if your system is not supported by the setup.sh script), follow the manual installation process and run `pip3 install -r requirements-dev.txt`.

This will install all required tools for development, including `pytest`, `flake8`, `mypy`, and `coveralls`.

## Modules

### Dynamic Pairlist

Expand Down

0 comments on commit 1be3d57

Please sign in to comment.