diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-09-03 19:51:41 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-09-03 19:51:41 +0200 |
| commit | 287ade1d321c983ddd00025864f9ea59d31c4493 (patch) | |
| tree | e0722c1ce91355762ffb05e482f958c7bbd5e777 /contributing.md | |
| parent | c818aa8a02d2809b3189a1fdbec580fd59d22ce2 (diff) | |
add googletest unit testing setup
Diffstat (limited to 'contributing.md')
| -rw-r--r-- | contributing.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md index c018917..f8c7d97 100644 --- a/contributing.md +++ b/contributing.md @@ -17,6 +17,13 @@ sure to separate the include statements using a blank line (clang-format may sort include statements, but does not sort across empty lines). +## CMakeLists specific + +- Make sure list arguments (e.g. sources, libraries) given to commands (e.g. + `target_sources`, `target_link_libraries`) are on separate lines. This makes + resolving merge conflicts when multiple sources were added by different + people to the same CMakeLists.txt easier. + # Documentation - All documentation is written in U.S. English @@ -26,4 +33,6 @@ - External libraries should be included as Git submodules under the `lib/` subdirectory +- When adding new submodules, make sure to manually set the `branch` and + `shallow` options in the [.gitmodules](./.gitmodules) file |