Skip to content

Commit b0134ea

Browse files
committed
Added instructions for pre-commit to contributing guide
1 parent 4abc0b8 commit b0134ea

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

CONTRIBUTING.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,17 @@ Ready to contribute? Here's how to set up `pyglotaran` for local development.
7878
(pyglotaran)$ python -m pip install -r requirements_dev.txt
7979
(pyglotaran)$ pip install -e . --process-dependency-links
8080

81-
4. Create a branch for local development::
81+
4. Install the ``pre-commit`` hooks, to automatically format and check your code::
82+
83+
$ pre-commit install
84+
85+
5. Create a branch for local development::
8286

8387
$ git checkout -b name-of-your-bugfix-or-feature
8488

8589
Now you can make your changes locally.
8690

87-
5. When you're done making changes, check that your changes pass flake8 and the
91+
6. When you're done making changes, check that your changes pass flake8 and the
8892
tests, including testing other Python versions with tox::
8993

9094
$ flake8 glotaran tests
@@ -95,13 +99,13 @@ Ready to contribute? Here's how to set up `pyglotaran` for local development.
9599
$ tox
96100

97101

98-
6. Commit your changes and push your branch to GitHub::
102+
7. Commit your changes and push your branch to GitHub::
99103

100104
$ git add .
101105
$ git commit -m "Your detailed description of your changes."
102106
$ git push origin name-of-your-bugfix-or-feature
103107

104-
7. Submit a pull request through the GitHub website.
108+
8. Submit a pull request through the GitHub website.
105109

106110
Pull Request Guidelines
107111
-----------------------

0 commit comments

Comments
 (0)