Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 1.11 KB
Raw

Contributing

Thanks for getting involved and contributing to the skel 🎉 Below are a few things to setup when submitting a PR.

Code comments

If adding new code, be sure to include relevant code comments. Code comments are a great way for others to learn from your code. This is especially true within the skeleton, since it is made for learning.

Update Documentation

Be sure to update any documentation relevant to your change. This includes updating the CHANGELOG.md.

Code Formatting

We use this script to install a consistent version of clang-format to format the code base. The format is automatically checked via a Travis CI build as well. Run the following script locally to ensure formatting is ready to merge:

make format

We also use clang-tidy as a C++ linter. Run the following command to lint and ensure your code is ready to merge:

make tidy

These commands are set from within the Makefile.