From 9b94e1463894c3fb2c37092a19dc3c04588741f7 Mon Sep 17 00:00:00 2001 From: hharutyunyan Date: Thu, 29 Aug 2019 02:44:00 +0400 Subject: [PATCH] Updating contribution docs. Added the link with a guide to install pre-commit and made the pre-commit installation command a code block. --- CONTRIBUTING.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 80d77164..d00f716b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -79,7 +79,8 @@ First time setup pip install -e ".[dev]" -- Install the pre-commit hooks: +- Install the `pre-commit framework`_. +- Install the pre-commit hooks:: pre-commit install --install-hooks @@ -89,6 +90,7 @@ First time setup .. _email: https://help.github.com/en/articles/setting-your-commit-email-address-in-git .. _Fork: https://github.com/pallets/flask/fork .. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork +.. _pre-commit framework: https://pre-commit.com/#install Start coding ~~~~~~~~~~~~