blob: f8c7d979286780c401af7eaa96b1ba7e18a6a99f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
# Contributing new code
- Please do the following *before* sending a pull request:
- Merge upstream code (if any) back into your own branch
- Run formatters/linters
# Git
- TODO: tagging / versions
- TODO: branch stability / gitflow?
# Code style
- Formatting nitty-gritty is handled by clang-format/clang-tidy
- ASCII only
- When using libraries of which the header include order is important, make
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
- TODO
# Libraries
- 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
|