aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--contributing.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
index 8ed3b80..88cba32 100644
--- a/contributing.md
+++ b/contributing.md
@@ -54,6 +54,9 @@ that you can click on to open them.
- Implementation details (if applicable)
- Header files (.h) contain the following types of comments:
- Usage documentation (required)
+
+ > [!NOTE]
+ > Constructors/destructors aren't required to have a `\brief` description
- Implementation details (if they affect the header)
- Design/data structure decisions (if applicable)
- <details><summary>