Added notes about Pre-Commit

microsoft · Sep 7, 2020 · 00fb796 · 00fb796
1 parent 45679f6
commit 00fb796
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -22,6 +22,7 @@ This is because a `Plaintext` object with slot-data written into the coefficient
 
 - Moved all files related to pkg-config to `pkgconfig/` subdirectory.
 - Added a new typedef `seal::seal_byte` for the unnecessarily capitalized `seal::SEAL_BYTE`.
+- Added `.pre-commit-config.yaml` (check out [pre-commit](https://pre-commit.com) if you are not familiar with this tool).
 
 ## Version 3.5.8
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,6 +20,8 @@ Simply follow the instructions provided by the bot. You will only need to do thi
 
 Microsoft SEAL uses a customized `.clang-format` configuration for C++ code styling.
 A script `tools/scripts/clang-format-all.sh` is provided to easily format all C++ sources and headers in the `native` directory.
+To ensure the code is properly formatted before making a pull request, we highly recommend using [pre-commit](https://pre-commit.com/).
+Note that the repository includes a `.pre-commit-config.yaml` that describes the appropriate formatting checks.
 
 Documentation are mostly written in GitHub-flavored Markdown.
 A line break is required after each full sentence.