From 8ff89409c7ee5399d98fe4a8e2a67961fab8add1 Mon Sep 17 00:00:00 2001
From: max-001 <maxsmits21@kpnmail.nl>
Date: Fri, 15 Nov 2024 17:24:03 +0100
Subject: Added code style

---
 contributing.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

(limited to 'contributing.md')

diff --git a/contributing.md b/contributing.md
index 3090727..64afb44 100644
--- a/contributing.md
+++ b/contributing.md
@@ -678,6 +678,86 @@ that you can click on to open them.
   uint64_t foo();
   ```
   </td></tr></table></details>
+- <details><summary>
+  Throw exceptions using standard C++ exceptions (such as <code>std::runtime_error</code>)
+  </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
+
+  ```cpp
+  if (error) {
+    throw std::runtime_error("An error occurred");
+  }
+  ```
+  </td><td>
+
+  ```cpp
+  if (error) {
+    throw "An error occurred";
+  }
+  ```
+  </td></tr></table></details>
+- <details><summary>
+  Constructors of classes derived from <code>Component</code> should be protected and <code>ComponentManager</code> should be declared as a friend class.
+  </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
+
+  ```cpp
+  class MyComponent : public Component {
+  protected:
+    MyComponent() = default;
+    friend class ComponentManager;
+  };
+  ```
+  </td><td>
+
+  ```cpp
+  class MyComponent : public Component {
+  public:
+    MyComponent() = default;
+  };
+  ```
+  </td></tr></table></details>
+- <details><summary>
+  Use of format specifiers (like <code>%s</code> and <code>%n</code>) are not allowed (use <code>{}</code> with <code>std::format</code> instead)
+  </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
+
+  ```cpp
+  std::string message = std::format("Hello, {}", name);
+  ```
+  </td><td>
+
+  ```cpp
+  char message[50];
+  sprintf(message, "Hello, %s", name);
+  ```
+  </td></tr></table></details>
+- <details><summary>
+  Argument names should be added in <code>.h</code> files (not only in <code>.cpp</code> and <code>.hpp</code> files)
+  </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
+
+  Foo.h:
+  ```cpp
+  void foo(int bar);
+  ```
+
+  Foo.cpp:
+  ```cpp
+  void foo(int bar) {
+    // ...
+  }
+  ```
+  </td><td>
+
+  Foo.h:
+  ```cpp
+  void foo(int);
+  ```
+
+  Foo.cpp:
+  ```cpp
+  void foo(int bar) {
+    // ...
+  }
+  ```
+  </td></tr></table></details>
 
 ## CMakeLists-specific
 
-- 
cgit v1.2.3


From 424611c6016e4a189e3a887fabe8e45b637e80f4 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Fri, 15 Nov 2024 17:39:04 +0100
Subject: merge #36

---
 contributing.md | 52 ++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 42 insertions(+), 10 deletions(-)

(limited to 'contributing.md')

diff --git a/contributing.md b/contributing.md
index 64afb44..5b0c79d 100644
--- a/contributing.md
+++ b/contributing.md
@@ -679,30 +679,57 @@ that you can click on to open them.
   ```
   </td></tr></table></details>
 - <details><summary>
-  Throw exceptions using standard C++ exceptions (such as <code>std::runtime_error</code>)
+  Utilize standard exceptions where appropriate (those found in <code>&lt;stdexcept&gt;</code>)
   </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
 
   ```cpp
-  if (error) {
-    throw std::runtime_error("An error occurred");
+  #include <stdexcept>
+
+  // ...
+
+  if (foo == nullptr) {
+    throw std::runtime_error("What is wrong");
   }
   ```
   </td><td>
 
   ```cpp
-  if (error) {
-    throw "An error occurred";
+  if (foo == nullptr) {
+    std::cout << "What is wrong" << std::endl;
+    exit(1);
   }
   ```
   </td></tr></table></details>
 - <details><summary>
-  Constructors of classes derived from <code>Component</code> should be protected and <code>ComponentManager</code> should be declared as a friend class.
+  Mention the name of the class when throwing an exception
+  </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
+
+  ```cpp
+  Foo::bar() {
+    if (...)
+      throw std::runtime_error("Foo: big error!");
+  }
+  ```
+  </td><td>
+
+  ```cpp
+  Foo::bar() {
+    if (...)
+      throw std::runtime_error("big error!");
+  }
+  ```
+  </td></tr></table></details>
+- <details><summary>
+  Constructors of classes derived from <code>Component</code> should be
+  protected and <code>ComponentManager</code> should be declared as a friend
+  class.
   </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
 
   ```cpp
   class MyComponent : public Component {
   protected:
-    MyComponent() = default;
+    MyComponent(...);
+    //! Only ComponentManager is allowed to create components
     friend class ComponentManager;
   };
   ```
@@ -711,16 +738,20 @@ that you can click on to open them.
   ```cpp
   class MyComponent : public Component {
   public:
-    MyComponent() = default;
+    MyComponent(...);
   };
   ```
   </td></tr></table></details>
 - <details><summary>
-  Use of format specifiers (like <code>%s</code> and <code>%n</code>) are not allowed (use <code>{}</code> with <code>std::format</code> instead)
+  C++ <code>std::format</code> should be used instead of C-style format specifiers
   </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
 
   ```cpp
   std::string message = std::format("Hello, {}", name);
+
+  dbg_logf("Here too: {}", 3);
+
+  throw std::runtime_error(std::format("Or here: {}", 5));
   ```
   </td><td>
 
@@ -730,7 +761,8 @@ that you can click on to open them.
   ```
   </td></tr></table></details>
 - <details><summary>
-  Argument names should be added in <code>.h</code> files (not only in <code>.cpp</code> and <code>.hpp</code> files)
+  Argument names should be added in <code>.h</code> files (not only in
+  <code>.cpp</code> and <code>.hpp</code> files)
   </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
 
   Foo.h:
-- 
cgit v1.2.3