aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorheavydemon21 <nielsstunnebrink1@gmail.com>2024-09-06 09:41:13 +0200
committerheavydemon21 <nielsstunnebrink1@gmail.com>2024-09-06 09:41:13 +0200
commitde77372027053744604cba732dce318159289b76 (patch)
tree1dfc2b81da65a508adfb62e60070addec9b75df7 /contributing.md
parentd2376c9713445a98cee9a24cfeb1029d140d19f7 (diff)
style code example added and added more examples in contributing.md
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
index 57a55b7..2d8a8cf 100644
--- a/contributing.md
+++ b/contributing.md
@@ -26,6 +26,39 @@
- [C++ core guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines)
- [Google c++ style](https://google.github.io/styleguide/cppguide.html)
+```cpp
+code-style-example/style.h
+```
+
+```cpp
+code-style-example/style.cpp
+```
+
+```cpp
+// good
+class MyClass
+{
+public:
+ void do_something(const int i);
+ void do_something(const std::string &str);
+};
+```
+
+```cpp
+// instead of doing this
+auto s = "Hello";
+auto x = "42"s;
+auto x = 42;
+auto x = 42.f;
+
+// Do this
+std::string s = "Hello";
+std::string x = "42"s;
+int x = 42;
+float x = 42.f;
+```
+
+
## CMakeLists specific
- Make sure list arguments (e.g. sources, libraries) given to commands (e.g.