Murmele/Gittyup
1
1
Fork 0
mirror of https://github.com/Murmele/Gittyup.git synced 2024-08-15 13:40:32 +03:00
Code Issues Projects Releases Wiki Activity

doc: update README - contributing

Browse Source 
Added a note to the `Contributing` section to invoke `cl-format.sh` and
to run the tests prior to creating any PR.
This commit is contained in:
Michael Werle 2023-08-24 08:58:09 +09:00
parent 16276638df
commit ea56be203f
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -194,6 +194,15 @@ branch. Create pull requests against the `master` branch. Follow the
[seven guidelines](https://chris.beams.io/posts/git-commit/) to writing a
great commit message.
Prior to committing a change, please use `cl-format.sh` to ensure your code
adheres to the formatting conventions for this project. You can also use the
`setup-env.sh` script to install a pre-commit hook which will automatically
run `clang-format` against all modified files.
Prior to pushing a change, please ensure you run the unit tests to avoid any
regressions. These are found in `<build-dir>/test` and can be run using
`ctest`.
License
-------