mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-05 05:52:37 +00:00
Code Issues 1 Projects Releases Wiki Activity

pre-commit: add documentation on how to use it

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5192>
This commit is contained in:
Andoni Morales Alastruey 2024-09-12 23:07:21 +02:00 committed by L. E. Segovia
parent 8c1ffd09d1
commit 44720cd2f4
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
subprojects/gst-docs/markdown/contribute/index.md
View file

@ -466,6 +466,38 @@ Other style guidelines:
[bitreader]: https://gstreamer.freedesktop.org/documentation/base/gstbitreader.html?gi-language=c#GstBitReader
[bytereader]: https://gstreamer.freedesktop.org/documentation/base/gstbytereader.html?gi-language=c#GstByteReader
##### Pre-commit
GStreamer uses [pre-commit](https://pre-commit.com/) to validate coding style automatically when you create a new commit.
pre-commit can be installed with `pip`:
```
pip install pre-commit
```
The pre-commit hooks are automatically installed the first you run `meson setup`.
They can be also be installed manually using:
```
pre-commit install
```
One installed, pre-commit will run automatically on every `git commit`.
You can also run manually all the pre-commit hooks using:
```
pre-commit run --all-files --show-diff-on-failure
```
When you create a new commit, the pre-commit hooks may apply changes to your files,
automatically fixing the issues found. When this happens, simply add the changes to
your staging environment, and re-run the commit.
You can bypass the pre-commit hooks using `git commit --no-verify`. The commits will
be validated in the CI's `check` stage, so you will still need to ensure that all
hooks passes correctly. To fix your commits, you can use the helper script located in
`scripts/check-commits.py` that will rebase your work starting from the commit passed
as first argument and it will run pre-commit for each commit, allowing you to fix them
individually rather than using a new commit on top of your branch to fix the issues found.
### Writing Good Commit Messages
Please take the time to write good and concise commit messages.