aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorJAROWMR <jarorutjes07@gmail.com>2024-12-03 21:38:21 +0100
committerJAROWMR <jarorutjes07@gmail.com>2024-12-03 21:38:21 +0100
commitef9088408b353a38f52d0542f1bca8c1ff7a14ff (patch)
treee27d58ce3802442ece98d3451ac9904c968b4f90 /contributing.md
parent41f9352ec236bbd0035644d983d9a2402bb8326f (diff)
Added doxygen features tab standard to contributing
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
index b0f623b..85e29bb 100644
--- a/contributing.md
+++ b/contributing.md
@@ -953,6 +953,23 @@ that you can click on to open them.
Foo & operator=(Foo &&) = delete;
```
</td></tr></table></details>
+- Features are described in the Doxygen Feature Tab (in this order):
+ - A feature description should explain the purpose and function of the feature,
+ focusing on what it enables or achieves for the gamedeveloper.
+ - Include additional information about when to implement the feature,
+ such as specific use cases or scenarios.
+ - Provide an example to demonstrate how gamedevelopers can enable or use the feature.
+ <!-- add example -->
+ - If the current feature depends on or reuses a previous feature,
+ include a link to that feature from the current feature (backward link, if applicable).
+ <!-- add example -->
+ - If the current feature depends on or reuses a previous feature,
+ include a link from the previous feature to the current feature (forward link, if applicable).
+ <!-- add example -->
+ > [!NOTE]
+ > A feature is almost never a component, system or large part of the engine.
+ > If a component or system has a single,
+ > distinct feature it should be named after that feature, not the component or system itself.
# Libraries