mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-30 04:33:53 +00:00
Code Issues Releases Wiki Activity

Adding contributing guide

Browse Source
This commit is contained in:
Henry Fredrick Schreiner 2017-05-31 12:13:18 -04:00
parent 27f718125d
commit c109ef5af6
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -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)

9
CONTRIBUTING.md Normal file
View File

@ -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).