~wegtam/smederee

Showing details for patch e841a72247bf55d2883d98656a811d051683029b.
2024-08-03 (Sat), 10:12 AM - Jens Grassel - e841a72247bf55d2883d98656a811d051683029b

codingstyle: include guidelines for naming things

Summary of changes
1 files modified with 6 lines added and 0 lines removed
  • CODINGSTYLE.md with 6 added and 0 removed lines
diff -rN -u old-smederee/CODINGSTYLE.md new-smederee/CODINGSTYLE.md
--- old-smederee/CODINGSTYLE.md	2024-11-23 09:08:28.955980147 +0000
+++ new-smederee/CODINGSTYLE.md	2024-11-23 09:08:28.955980147 +0000
@@ -13,6 +13,12 @@
 3. The configuration file for Scalafix SHALL be the file [.scalafix.conf](.scalafix.conf) in the project root and SHALL be configured to organize (rewrite) import rules.
 4. In the rare case of formatting interfering with code functionality, it is RECOMMENDED to disable automatic code formatting for the affected parts of the code only.
 5. An `.editorconfig` file in the project root MUST exist and SHALL contain the necessary settings.
+6. All names (e.g. variables, functions, etc.) SHALL use the [camel case](https://en.wikipedia.org/wiki/Camel_case) notation and MUST start with a lowercase letter. Please follow these guidelines for naming things:
+    1. Names SHOULD NOT be ambiguous or unclear.
+    2. Names MUST NOT use abbreviations that could be confusing.
+    3. Names MUST NOT use hungarian notation i.e. never prefix or suffix names with their types like for example `stringNameOption`.
+    4. Names SHOULD NOT consist of more than 4 words.
+    5. Similar names SHOULD be used for similar objects in the code.
 
 ### 2.1. Additions to the `defaultWithAlign` preset