QGIS/.github/CONTRIBUTING.md
2023-10-11 23:21:58 +02:00

30 lines
968 B
Markdown

Contributing to QGIS
====================
QGIS is an open source project and we appreciate contributions very much.
Proper formatting
-----------------
Before making a pull request, please make sure your code is properly formatted
by running the prepare commit script **before** issuing `git commit`.
./scripts/prepare_commit.sh
This can be automated by adding it to a pre-commit hook, for example:
pushd $(git rev-parse --git-common-dir)/hooks
test -e pre-commit && mv pre-commit pre-commit.000
echo '$(git rev-parse --show-toplevel)/scripts/prepare_commit.sh' > pre-commit
chmod +x pre-commit
popd
Getting your pull request merged
--------------------------------
This is a volunteer project, so sometimes it may take a little while to merge
your pull request.
There is a [guide with hints for getting your pull requests merged](https://docs.qgis.org/testing/en/docs/developers_guide/git.html#pull-requests)
in the developers guide.