Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hendrik Muhs committed Jan 20, 2018
1 parent 19ffed8 commit d81124b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions keyvi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,13 @@ Example:
`<BUILD_TYPE>` can be `release`, `debug`, `coverage` or any other available by default in `cmake`

To run cpp unit tests just execute `unit_test_all` executable.

## Coding Rules

The cpp part of keyvi has to pass the [https://pypi.python.org/pypi/cpplint](cpplint) checks as well as [https://clang.llvm.org/docs/ClangFormat.html](clang-format) (5.0.0 at the moment, defined by our travis CI configuration).

The configuration of both tools is part of the project. You can check your changes against the config using the `check-style.sh` script. For your convenience consider using a plugin for your IDE of choice (e.g. CppStyle for Eclipse).

Formatting is not done automatically for you but code neads to be cleanly pushed.

The check must pass for all changed, including new, files.

0 comments on commit d81124b

Please sign in to comment.