1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00

docs: Updated includes rules in CONTRIBUTING.md

This commit is contained in:
Diadlo 2016-11-16 23:18:00 +03:00
parent b4a9f04f92
commit 5921122960
No known key found for this signature in database
GPG Key ID: 5AF9F2E29107C727

View File

@ -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