diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-10 12:31:36 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-10 12:31:36 +0200 |
| commit | 128969619a22dfc17a9ea35335c0d21c6ad0c954 (patch) | |
| tree | 33c0dfe9472c304e240a75137614ea1a3c373930 | |
| parent | 579824011d5e8776e2079d6624a39535517760ff (diff) | |
update contributing.md
| -rw-r--r-- | contributing.md | 5 | ||||
| -rw-r--r-- | readme.md | 4 |
2 files changed, 7 insertions, 2 deletions
diff --git a/contributing.md b/contributing.md index 364e835..e5d4bd8 100644 --- a/contributing.md +++ b/contributing.md @@ -59,6 +59,11 @@ declaration instead of using the constructor. - Header files declare either a single class or symbols within a single namespace. +- Use of the `auto` type is not allowed, with the following exceptions: + - When naming the item type in a range-based for loop + - When calling template factory methods that explicitly name the return type + in the function call signature + - When fetching a singleton instance ## CMakeLists specific @@ -5,10 +5,10 @@ This repository contains: |folder|content| |-|-| |`lib/`|third-party libraries as git submodules| -|`mwe/`|minimal working examples and proof-of-concepts| +|`mwe/`|minimal working examples and standalone proof-of-concepts (isolated from the engine)| |`src/crepe/`|game engine source code| |`src/test/`|unit tests| -|`src/example/`|standalone examples using game engine| +|`src/example/`|standalone examples or proof-of-concepts using game engine internals| ## Compilation |