Skip to content

Commit

Permalink
Add pre-commit hooks setup step in how to contribute patches
Browse files Browse the repository at this point in the history
Also use real step numbers so you don't need a markdown renderer
to read the content and use consistent capitalization in phrases

Suggest to use pre-commit

[skip ci]
  • Loading branch information
strk committed Jan 24, 2025
1 parent b1e8df2 commit 9a4f6e7
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ You can help us **by submitting bug reports or fixing bugs** in the [QGIS bug tr

If you wish to contribute patches you can:

1. [fork the project](https://help.github.com/forking/)
1. make your changes
1. commit to your repository
1. and then [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
1. [Fork the project](https://help.github.com/forking/)
2. Install the [pre-commit](https://pre-commit.com/) hook: `pre-commit install --install-hooks` (version 4.1+ required)
3. Make your changes
4. Commit to your repository
5. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)

The development team can then review your contribution and commit it upstream as appropriate.

Expand Down

0 comments on commit 9a4f6e7

Please sign in to comment.