diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-08 13:48:01 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-08 13:48:01 +0200 |
| commit | 6b7a670d60fec808e4fd1fcf3a8df2c503dcbdf4 (patch) | |
| tree | aeb947a0001088ae2caddca85062845a276ceffb /contributing.md | |
| parent | c6cbde11c080c994577a7ebe4b966c25870dec1f (diff) | |
| parent | 515aab5ab7e3281d2d77177724aae42cffc6faae (diff) | |
Merge branch 'loek/cleanup' of github.com:lonkaars/crepe
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 |