Skip to content

Commit da9dbde

Browse files
Document how to use clang-format and add a test
1 parent f31bf75 commit da9dbde

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
We encourage everyone to contribute improvements and bug fixes to SymCC. Our
44
preferred way of accepting contributions is via GitHub pull requests. Please be
5-
sure to run clang-format on any C/C++ code you change, and ideally add a test to
6-
your patch. Unfortunately, since the project is a bit short on developers at the
5+
sure to run clang-format on any C/C++ code you change; an easy way to do so is
6+
with `git clang-format --style LLVM` just before committing. (On Ubuntu, you can
7+
get `git-clang-format` via `apt install clang-format`.) Ideally, also add a test
8+
to your patch (see the
9+
[docs](https://github.com/eurecom-s3/symcc/blob/master/docs/Testing.txt) for
10+
details). Unfortunately, since the project is a bit short on developers at the
711
moment, we have to ask for your patience while we review your PR.
812

913
Please note that any contributions you make are licensed under the same terms as

0 commit comments

Comments
 (0)