Skip to content

Commit 3982369

Browse files
authoredOct 18, 2017
Update CONTRIBUTING.md
1 parent 2c391cc commit 3982369

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed
 

‎CONTRIBUTING.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ in the [DASH Documentation Wiki](http://doc.dash-project.org/) for useful hints
1515
on the code base, build configurations, debugging, HPC system setups etc.
1616

1717

18+
Design Guidelines
19+
-----------------
20+
21+
DASH follows the terminology and concepts described in the
22+
[ISO C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md).
23+
We kindly, yet firmly, ask all contributors to get familiar with this insightful
24+
document to keep pull request review cycles nice and brief.
25+
26+
1827
Code Style
1928
----------
2029

@@ -36,7 +45,7 @@ and some DASH-specific tags.
3645

3746
This example should illustrate all you need:
3847

39-
~~~c++
48+
```c++
4049
/**
4150
* Multi-line comment opened with double-star "/**".
4251
* First paragraph is brief description.
@@ -81,7 +90,7 @@ bool wombatify(
8190
) {
8291
// Any comment here is ignored, no matter how it is formatted.
8392
}
84-
~~~
93+
```
8594

8695

8796
Contributing Code

0 commit comments

Comments
 (0)
Please sign in to comment.