Adding contribution guide

Henry Fredrick Schreiner
1 parent 79cd791f
Showing 3 changed files with 27 additions and 1 deletions
CHANGELOG.md
CONTRIBUTING.md
README.md
@@ -3,6 +3,7 @@
 * Added `remaining()` and `remaining_size()` [#37](https://github.com/CLIUtils/CLI11/pull/37)
 * `allow_extras` and `prefix_command` are now valid on subcommands [#37](https://github.com/CLIUtils/CLI11/pull/37)
+
 ## Version 1.2
 * Added functional form of flag [#33](https://github.com/CLIUtils/CLI11/pull/33), automatic on C++14
+
+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
+
@@ -321,10 +321,14 @@ And, in your main function:
 ## Contributing
-To contribute, open an [issue][Github Issues] or [pull request][Github Pull Requests] on GitHub, or ask a question on [gitter].
+To contribute, open an [issue][Github Issues] or [pull request][Github Pull Requests] on GitHub, or ask a question on [gitter]. The is also a short note to contributors [here](./CONTRIBUTING.md).
 As of version 1.0, this library is available under a 3-Clause BSD license. See the [LICENSE](./LICENSE) file for details.
+This project was created by Henry Schreiner. Significant features and/or improvements to the code were contributed by:
+
+* Marcus Brinkmann
+
 CLI11 was developed at the [University of Cincinnati] to support of the [GooFit] library under [NSF Award 1414736]. It was featured in a [DIANA/HEP] meeting at CERN. Please give it a try! Feedback is always welcome.