diff options
| author | Bui Nguyen Quoc Thanh <49302843+thanhbnq@users.noreply.github.com> | 2022-12-14 16:09:23 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-14 10:09:23 +0100 |
| commit | 198715eb7d606515c1dd22187080cae483480849 (patch) | |
| tree | 8c589931dd773e73c46c7510abf5e4de172b02ee /README.md | |
| parent | 4857ffca487d551564dfee41d1ad89f2db9ac1af (diff) | |
| download | DLT-daemon-198715eb7d606515c1dd22187080cae483480849.tar.gz | |
Updates for Coding Styles (#425)
- Remove uncrustify
- Use clang-format and pre-commit hooks script
- Update README accordingly
Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 15 insertions, 3 deletions
@@ -196,10 +196,22 @@ make sure to follow the ### Coding Rules -Before contributing code, run uncrustify to harmonize code style. +This project is now using clang-format as replacement of uncrustify. -Configuration: util/uncrustify.cfg -uncrustify version: 0.68\_f +For convenience, any code changes will be harmonized before commit by hooks/pre-commit. + +- Install clang-format + +- Install pre-commit script by: + + ```bash + cp scripts/pre-commit.sample .git/hooks/pre-commit + ``` + +- Configuration: .clang-format + +For reference to clang-format, you can check with: +[Configurator](https://zed0.co.uk/clang-format-configurator/) ## Known issues |