File tree Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Original file line number Diff line number Diff line change @@ -78,13 +78,17 @@ Ready to contribute? Here's how to set up `pyglotaran` for local development.
78
78
(pyglotaran)$ python -m pip install -r requirements_dev.txt
79
79
(pyglotaran)$ pip install -e . --process-dependency-links
80
80
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::
82
86
83
87
$ git checkout -b name-of-your-bugfix-or-feature
84
88
85
89
Now you can make your changes locally.
86
90
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
88
92
tests, including testing other Python versions with tox::
89
93
90
94
$ flake8 glotaran tests
@@ -95,13 +99,13 @@ Ready to contribute? Here's how to set up `pyglotaran` for local development.
95
99
$ tox
96
100
97
101
98
- 6 . Commit your changes and push your branch to GitHub::
102
+ 7 . Commit your changes and push your branch to GitHub::
99
103
100
104
$ git add .
101
105
$ git commit -m "Your detailed description of your changes."
102
106
$ git push origin name-of-your-bugfix-or-feature
103
107
104
- 7 . Submit a pull request through the GitHub website.
108
+ 8 . Submit a pull request through the GitHub website.
105
109
106
110
Pull Request Guidelines
107
111
-----------------------
You can’t perform that action at this time.
0 commit comments