docs: update coding rules

lc-soft · Mar 24, 2018 · a177292 · a177292
1 parent 1b46c00
commit a177292
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -76,7 +76,9 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
 
 - All features or bug fixes **must be tested** by one or more specs (unit-tests).
 - All public API methods **must be documented**. (Details TBC).
-- Follow the existing code style.
+- Follow the existing code style. You have the following two ways to format the code:
+  - Use [clang-format](http://clang.llvm.org/docs/ClangFormat.html) to format the changed files: `clang-format --style=file [src/????.c]`.
+  - Install the [NodeJS](https://nodejs.org/en/) Environment and run `npm install`, which will add a git hook to format the changed code, and it will run before you run `git commit`.
 
 ## Commit Message Guidelines