summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbunnei <bunneidev@gmail.com>2015-08-17 09:15:46 -0400
committerbunnei <bunneidev@gmail.com>2015-08-17 09:15:46 -0400
commitef7eb8bc4c2b761a5dc6623156694be057e7a416 (patch)
tree8633316bd572f58d1389d3315fea0bc28ad9806e
parent1f18c9f8dd68b44fe949ef50e3fad753f4dc52d0 (diff)
parent44ef68fb4873b49af880a164f0619d4a35860875 (diff)
Merge pull request #1038 from LittleWhite-tb/contributing-include
Add coding style about includes
-rw-r--r--CONTRIBUTING.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f2dbdf1a4..28b8b4031 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,6 +25,22 @@ Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spac
* For items that are both defined and declared in two separate files, put the doc-comment only next to the associated declaration. (In a header file, usually.) Otherwise, put it next to the implementation. Never duplicate doc-comments in both places.
```cpp
+// Includes should be sorted lexicographically
+// STD includes first
+#include <map>
+#include <memory>
+
+// then, library includes
+#include <nihstro/shared_binary.h>
+
+// finally, citra includes
+#include "common/math_util.h"
+#include "common/vector_math.h"
+
+// each major module is separated
+#include "video_core/pica.h"
+#include "video_core/video_core.h"
+
namespace Example {
// Namespace contents are not indented