mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-05-03 05:53:52 +00:00
Code Issues Releases Wiki Activity
CLI11/CONTRIBUTING.md
Henry Fredrick Schreiner 366716eebc Moving check_style
2017-11-20 18:07:13 -05:00

1.0 KiB
Raw Blame History

Thanks for considering to write a Pull Request (PR) for CLI11! Here are a few guidelines to get you started:

Make sure you are comfortable with the license; all contributions are licensed under the original license.

Adding functionality

Make sure any new functions you add are are:

  • Documented by /// documentation for Doxygen
  • Mentioned in the instructions in the README, though brief mentions are okay
  • Explained in your PR (or previously explained in an Issue mentioned in the PR)
  • Completely covered by tests

In general, make sure the addition is well thought out and does not increase the complexity of CLI11 if possible.

Things you should know:

  • Once you make the PR, tests will run to make sure your code works on all supported platforms
  • The test coverage is also measured, and that should remain 100%
  • 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