From ea56be203f52940dac87ff63015655d67c6ca700 Mon Sep 17 00:00:00 2001 From: Michael Werle Date: Thu, 24 Aug 2023 08:58:09 +0900 Subject: [PATCH] doc: update README - contributing Added a note to the `Contributing` section to invoke `cl-format.sh` and to run the tests prior to creating any PR. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 408a6f45..9d5a7c0f 100644 --- a/README.md +++ b/README.md @@ -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 `/test` and can be run using +`ctest`. + License -------