From ecb0e43c2a29d4dc9912eaf49b97dbb7214796a7 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 8 Apr 2022 17:50:32 +0200 Subject: [PATCH] Improve pre-commit docs --- CONTRIBUTING.md | 2 -- docs/developer.md | 3 ++- requirements-dev.txt | 3 +-- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae9c5d81e..b4e0bc024 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,8 +20,6 @@ Best start by reading the [documentation](https://www.freqtrade.io/) to get a fe ## Before sending the PR -Do the following if you disabled pre-commit hook when commiting. - ### 1. Run unit tests All unit tests must pass. If a unit test is broken, change your code to diff --git a/docs/developer.md b/docs/developer.md index 18465238f..0434ecb3e 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -26,7 +26,8 @@ Alternatively (e.g. if your system is not supported by the setup.sh script), fol This will install all required tools for development, including `pytest`, `flake8`, `mypy`, and `coveralls`. -Then install the git hook scripts by running `pre-commit install` +Then install the git hook scripts by running `pre-commit install`, so your changes will be verified locally before committing. +This avoids a lot of waiting for CI already, as some basic formatting checks are done locally on your machine. Before opening a pull request, please familiarize yourself with our [Contributing Guidelines](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md). diff --git a/requirements-dev.txt b/requirements-dev.txt index 5266ad003..c510b107d 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -3,7 +3,6 @@ -r requirements-plot.txt -r requirements-hyperopt.txt - coveralls==3.3.1 flake8==4.0.1 flake8-tidy-imports==4.6.0 @@ -28,4 +27,4 @@ types-requests==2.27.15 types-tabulate==0.8.6 # Extensions to datetime library -types-python-dateutil==2.8.10 \ No newline at end of file +types-python-dateutil==2.8.10