aboutsummaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGravatar Eric Fiselier <eric@efcs.ca>2017-10-11 17:38:16 -0600
committerGravatar Eric Fiselier <eric@efcs.ca>2017-10-12 13:01:26 -0600
commit894a869e7b5d7c1c04b9583e706e21cef6a1d6d6 (patch)
tree4277a1e38d6c90c2f58cc2e734b8db332218caf8 /CONTRIBUTING.md
parent40b90bcfda2d08c55c1bb347d1780321f5896868 (diff)
Add Google-style .clang-format file.
It would be nice if the repository contained a clang-format config file so that PR submitters could use tooling to correctly format their code match Googles/abseils style. This also makes it easier for reviewers to specify what coding style should be used. ie the one the tooling produces. The clang-format file is the default Google configuration as dumped by `clang-format`. I'm not sure abseil will want the exact same options, but it seemed like the right starting place.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c9c89bb..865da86 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -47,7 +47,8 @@ will be expected to conform to the style outlined
made and **why** it was made. Link to a GitHub issue if it exists.
* Don't fix code style and formatting unless you are already changing that
- line to address an issue. PRs with irrelevant changes won't be merged. If
+ line to address an issue. Formatting of modified lines may be done using
+ `git clang-format`. PRs with irrelevant changes won't be merged. If
you do want to fix formatting or style, do that in a separate PR.
* Unless your PR is trivial, you should expect there will be reviewer comments