diff options
| author | max-001 <maxsmits21@knpmail.nl> | 2024-10-09 10:54:50 +0200 |
|---|---|---|
| committer | max-001 <maxsmits21@knpmail.nl> | 2024-10-09 10:54:50 +0200 |
| commit | f5b4e2c84326bd96c78ad1f6e4481c1970e54444 (patch) | |
| tree | aa75ef01ace01d86ffda93632e0b40dc11e0dcbc /contributing.md | |
| parent | 765550bce8a81c6f0c79c0083b14ef68e0c900b2 (diff) | |
| parent | 6b7a670d60fec808e4fd1fcf3a8df2c503dcbdf4 (diff) | |
Merge remote-tracking branch 'origin/master' into max/POC-ECS-homemade
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 |