Commit 38340c063357c64603a6661334364259711fd057
1 parent
909d72bf
Removing extra copy of CONTRIBUTING
[skip ci]
Showing
2 changed files
with
24 additions
and
23 deletions
.github/CONTRIBUTING.md
| 1 | -# A few notes on contributions | |
| 1 | +Thanks for considering to write a Pull Request (PR) for CLI11! Here are a few guidelines to get you started: | |
| 2 | 2 | |
| 3 | -If you want to add code, please make sure it passes the clang-format style (I am using LLVM 4.0): | |
| 3 | +Make sure you are comfortable with the license; all contributions are licensed under the original license. | |
| 4 | + | |
| 5 | +## Adding functionality | |
| 6 | +Make sure any new functions you add are are: | |
| 7 | + | |
| 8 | +* Documented by `///` documentation for Doxygen | |
| 9 | +* Mentioned in the instructions in the README, though brief mentions are okay | |
| 10 | +* Explained in your PR (or previously explained in an Issue mentioned in the PR) | |
| 11 | +* Completely covered by tests | |
| 12 | + | |
| 13 | +In general, make sure the addition is well thought out and does not increase the complexity of CLI11 needlessly. | |
| 14 | + | |
| 15 | +## Things you should know: | |
| 16 | + | |
| 17 | +* Once you make the PR, tests will run to make sure your code works on all supported platforms | |
| 18 | +* The test coverage is also measured, and that should remain 100% | |
| 19 | +* Formatting should be done with clang-format, otherwise the format check will not pass. However, it is trivial to apply this to your PR, so don't worry about this check. If you do have clang-format, just run `scripts/check_style.sh` | |
| 20 | +* Everything must pass clang-tidy as well, run with `-DCLANG_TIDY_FIX-ON` (make sure you use a single threaded build process!) | |
| 21 | + | |
| 22 | +Note that the style check is really just: | |
| 4 | 23 | |
| 5 | 24 | ```bash |
| 6 | 25 | git ls-files -- '.cpp' '.hpp' | xargs clang-format -i -style=file |
| 7 | 26 | ``` |
| 8 | 27 | |
| 9 | -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). | |
| 28 | +And, if you want to always use it, feel free to install the git hook provided in stripts. | |
| 29 | + | |
| 30 | + | ... | ... |
CONTRIBUTING.md deleted
| 1 | - | |
| 2 | -Thanks for considering to write a Pull Request (PR) for CLI11! Here are a few guidelines to get you started: | |
| 3 | - | |
| 4 | -Make sure you are comfortable with the license; all contributions are licensed under the original license. | |
| 5 | - | |
| 6 | -## Adding functionality | |
| 7 | -Make sure any new functions you add are are: | |
| 8 | - | |
| 9 | -* Documented by `///` documentation for Doxygen | |
| 10 | -* Mentioned in the instructions in the README, though brief mentions are okay | |
| 11 | -* Explained in your PR (or previously explained in an Issue mentioned in the PR) | |
| 12 | -* Completely covered by tests | |
| 13 | - | |
| 14 | -In general, make sure the addition is well thought out and does not increase the complexity of CLI11 if possible. | |
| 15 | - | |
| 16 | -## Things you should know: | |
| 17 | - | |
| 18 | -* Once you make the PR, tests will run to make sure your code works on all supported platforms | |
| 19 | -* The test coverage is also measured, and that should remain 100% | |
| 20 | -* Formatting should be done with clang-format, otherwise the format check will not pass. However, it is trivial to apply this to your PR, so don't worry about this check. If you do have clang-format, just run `scripts/check_style.sh` |