diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-05 14:57:26 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-05 14:57:26 +0200 |
| commit | b5a5d9b1d4725f3001486c9bbd69263ed0918303 (patch) | |
| tree | b2357821f7f7be7c33704242f76943513df00741 /contributing.md | |
| parent | e54ebc7e74f3ca94de3467a03397c0aad2aed079 (diff) | |
update code style
Diffstat (limited to 'contributing.md')
| -rw-r--r-- | contributing.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md index eec5bc0..2ff411a 100644 --- a/contributing.md +++ b/contributing.md @@ -22,6 +22,14 @@ - 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 |