diff options
| -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 a6e5074..775119a 100644 --- a/contributing.md +++ b/contributing.md @@ -65,6 +65,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 - Only use member initializer lists for non-trivial types. - C++-style structs should define default values for all non-trivial fields. - Declare incomplete classes instead of including the relevant header where @@ -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 |