From 34bd1a7083e5875e6a4b2d4f61c0b356cc5d53fc Mon Sep 17 00:00:00 2001 From: Jesse Beder Date: Mon, 28 Mar 2016 23:47:21 -0500 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41f50dc..cd09a1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,18 @@ This project is formatted with [clang-format][fmt] using the style file at the root of the repository. Please run clang-format before sending a pull request. -In general, try to follow the style of surrounding code. +In general, try to follow the style of surrounding code. We mostly follow the [Google C++ style guide][cpp-style]. + +Commit messages should be in the imperative mood, as described in the [Git contributing file][git-contrib]: + +> Describe your changes in imperative mood, e.g. "make xyzzy do frotz" +> instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy +> to do frotz", as if you are giving orders to the codebase to change +> its behaviour. [fmt]: http://clang.llvm.org/docs/ClangFormat.html +[cpp-style]: https://google.github.io/styleguide/cppguide.html +[git-contrib]: http://git.kernel.org/cgit/git/git.git/tree/Documentation/SubmittingPatches?id=HEAD # Tests