From c109ef5af65bcbe35d28ffeb1f4f71231881ec6b Mon Sep 17 00:00:00 2001 From: Henry Fredrick Schreiner Date: Wed, 31 May 2017 12:13:18 -0400 Subject: [PATCH] Adding contributing guide --- CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 9 +++++++++ 2 files changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e506f43..0b165279 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## Version 1.0 (in progress) +* Cleanup using `clang-tidy` and `clang-format` +* Small improvements to Timers, easier to subclass Error + ## Version 0.9 * Better CMake named target (CLI11) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ebcc17a2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +#A few notes on contributions + +If you want to add code, please make sure it passes the clang-format style (I'm using LLVM 4.0): + +```bash +git ls-files | grep -E '.cpp|.hpp' | xargs clang-format -i -style=file +``` + +It is also a good idea to check this with `clang-tidy`; automatic fixes can be made using `-DCLANG_TIDY_FIX-ON` (resets to `OFF` when rerunning CMake).