Reorder and revamp the documentation

kratos47mhs · Jan 3, 2018 · 284c6c4 · 284c6c4
1 parent fd5497c
commit 284c6c4
Show file tree

Hide file tree

Showing 15 changed files with 1,129 additions and 229 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,16 +1,21 @@
+# Contribute to freqtrade
+
 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).
+- 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
+**Before sending the PR:**
+
+## 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
+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
@@ -26,7 +31,8 @@ pytest freqtrade/tests/test_<file_name>.py
 ```bash
 pytest freqtrade/tests/test_<file_name>.py::test_<method_name>
 ```
-## Test if your code is PEP8 compliant
+
+## 2. Test if your code is PEP8 compliant
 **Install packages** (If not already installed)
 ```bash
 pip3.6 install flake8 coveralls