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:
parent
b4a9f04f92
commit
5921122960
@ -353,15 +353,15 @@ Use `C++11`.
|
|||||||
|
|
||||||
## Includes
|
## Includes
|
||||||
|
|
||||||
On the project level, include files starting with the root directory of the
|
On the project level, include files starting with the module name, e.g.
|
||||||
repository, e.g. `src/core/core.h` from `src/widget/widget.cpp`:
|
`core/core.h` from `widget/widget.cpp`:
|
||||||
|
|
||||||
```C++
|
```C++
|
||||||
#include "src/core/core.h"
|
#include "core/core.h"
|
||||||
```
|
```
|
||||||
|
|
||||||
Do **not** use `<>` tags to include files on the project level, e.g.
|
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++
|
```C++
|
||||||
#include <core.h> // WRONG
|
#include <core.h> // WRONG
|
||||||
|
Loading…
x
Reference in New Issue
Block a user