Skip to content

Commit 3a41bff

Browse files
committed
docs: add non-relative includes to coding standard
1 parent 241d364 commit 3a41bff

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

doc/contribute.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ If there are no preconfigured rules for your IDE, you can use one of the existin
9494
- **Includes** :
9595
- files from the project : `#include "relative/path/to/the/file.h"`
9696
- external files and std : `#include <file.h>`
97+
- use includes relative to included directories like `src`, not relative to the current file. Don't do: `#include "../file.h"`
9798
- Only use [primary spellings for operators and tokens](https://en.cppreference.com/w/cpp/language/operator_alternative)
9899
- Use auto sparingly. Don't use auto for [fundamental/built-in types](https://en.cppreference.com/w/cpp/language/types) and [fixed width integer types](https://en.cppreference.com/w/cpp/types/integer), except when initializing with a cast to avoid duplicating the type name.
99100
- Examples:

0 commit comments

Comments
 (0)