From 84ca77c8de172355effb20472413a178390a478c Mon Sep 17 00:00:00 2001
From: CanbiZ <47820557+MickLesk@users.noreply.github.com>
Date: Fri, 6 Dec 2024 13:26:15 +0100
Subject: [PATCH] Created Coding Standards (markdown)

---
 Coding-Standards.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 Coding-Standards.md

diff --git a/Coding-Standards.md b/Coding-Standards.md
new file mode 100644
index 0000000..2c7db83
--- /dev/null
+++ b/Coding-Standards.md
@@ -0,0 +1,27 @@
+We maintain a set of coding standards to ensure consistency and readability across the scripts in this repository.
+
+## Key Guidelines:
+1. **Indentation**: Use **2 spaces** for indentation (no tabs).
+2. **Variable Naming**: Use **uppercase** for global variables and **snake_case** for local variables.
+3. **Quoting Variables**: Always quote variables to prevent issues with spaces or special characters:
+    ```bash
+    echo "$MY_VARIABLE"
+    ```
+4. **Functions**: Define functions using the following format:
+    ```bash
+    my_function() {
+        # function code
+    }
+    ```
+
+5. **Error Handling**: Always include error handling:
+    ```bash
+    catch_errors
+    ```
+
+6. **Comments**: Use comments to explain the purpose of complex code:
+    ```bash
+    # This section installs the required dependencies
+    ```
+
+7. **No Hardcoding**: Avoid hardcoding values like usernames or paths. Use variables and configuration files instead.