2.0 KiB
Contributing to mp-units
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
Gitpod
The easiest way to start coding is to jump streight into Gitpod. You can either click the button
below or prefix any mp-units URL (main branch, other branches, issues, PRs, ...) in your web browser with gitpod.io/#
(i.e. https://gitpod.io/#https://github.com/mpusz/units).
Download, Build, Install
Alternatively, please refer to our official docs for download, build, and install instructions if you want to setup a development environemnt on your local machine.
Where to start?
If you are looking for a good issue to start with, please check the following:
- good first issue - issues that should be pretty simple to implement.
- help wanted - issues that typically are a bit more involved than beginner issues.
- high priority - things to fix ASAP but often of higher complexity.
Code Formatting
We intend to use clang-format when it finally learns what a C++ concept is 😉.
Until then, please code alike what is there already:
- 2 spaces for indentation
- no indentation for namespaces
- types, functions, variables naming in a
standard_case - template parameters in a
PascalCase
Backward Compatibility
Before submission, please remember to check if the code compiles fine on the supported compilers. The CI will check it anyway but it is good to check at least some of the configurations before pushing changes. Especially older compilers can be tricky as those do not support all the C++20 features well enough. The official list of supported compilers can be always found on our Usage page.