diff --git a/docs/contributing.rst b/docs/contributing.rst index c76eb4e..cabd8b4 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -21,16 +21,22 @@ Setting up a development environment We recommend using a `virtualenv `_. 1. Clone the repository. If you're planning to make pull request, you should fork -the repository on GitHub and clone your fork instead of the main repo:: +the repository on GitHub and clone your fork instead of the main repo: + +.. code:: bash $ git clone https://github.com/yourusername/cti-python-stix2.git -2. Install develoment-related dependencies:: +2. Install develoment-related dependencies: + +.. code:: bash $ cd cti-python-stix2 $ pip install -r requirements.txt -3. Install [pre-commit](http://pre-commit.com/#usage) git hooks. +3. Install `pre-commit `_ git hooks: + +.. code:: bash $ pre-commit install