Browse Source

docs: Updated includes rules in CONTRIBUTING.md

pull/3885/head
Diadlo 9 years ago
parent
commit
5921122960
No known key found for this signature in database
GPG Key ID: 5AF9F2E29107C727
  1. 8
      CONTRIBUTING.md

8
CONTRIBUTING.md

@ -353,15 +353,15 @@ Use `C++11`. @@ -353,15 +353,15 @@ Use `C++11`.
## Includes
On the project level, include files starting with the root directory of the
repository, e.g. `src/core/core.h` from `src/widget/widget.cpp`:
On the project level, include files starting with the module name, e.g.
`core/core.h` from `widget/widget.cpp`:
```C++
#include "src/core/core.h"
#include "core/core.h"
```
Do **not** use `<>` tags to include files on the project level, e.g.
`src/core/core.h` from `src/widget/widget.cpp`:
`core/core.h` from `widget/widget.cpp`:
```C++
#include <core.h> // WRONG

Loading…
Cancel
Save