From a0fdbded2dc3d268644c798b2cab7853ac66c26a Mon Sep 17 00:00:00 2001 From: Michel Roegl-Brunner <73236783+michelroegl-brunner@users.noreply.github.com> Date: Mon, 13 Jan 2025 14:07:14 +0100 Subject: [PATCH] Destroyed Coding Standards (markdown) --- Coding-Standards.md | 27 --------------------------- 1 file changed, 27 deletions(-) delete mode 100644 Coding-Standards.md diff --git a/Coding-Standards.md b/Coding-Standards.md deleted file mode 100644 index 2c7db83..0000000 --- a/Coding-Standards.md +++ /dev/null @@ -1,27 +0,0 @@ -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.