blob: 933f1bfe02e454bc4050a05e11eb4b076ec6485d (
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# 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
- Push as often as possible
- Development is done on separate branches, these follow a pattern of
`name/feature` (i.e. `loek/dll-so-poc` or `jaro/class2`)
- The master branch is considered stable, and should always contain a
working/compiling version of the project
- TODO: tagging / versions
# Code style
- ASCII only
- Explanatory comments are placed above the line(s) they are explaining
- Source files should only contain comments that plainly state what the code is
supposed to do
- Explanatory comments in headers may be used to clarify implementation design
decisions
- Formatting nitty-gritty is handled by clang-format/clang-tidy (run `make
format` in the root folder of this repository to format all sources files)
- 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).
- All engine-related code is implemented under the `crepe` namespace,
user-facing APIs under `crepe::api` (the folder structure should also reflect
this).
- `using namespace` may not be used in header files, only in source files.
- Do not (indirectly) include private dependency headers in API header files,
as these are no longer accessible when the engine is installed
- Getter and setter functions are appropriately prefixed with `get_` and
`set_`.
## 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
# Libraries
- External libraries should be included as Git submodules under the `lib/`
subdirectory
- When adding new submodules, please set the `shallow` option to `true` in the
[.gitmodules](./.gitmodules) file
|