From 282deb4697cf585971ec9108246bd850ef9860a3 Mon Sep 17 00:00:00 2001 From: fiftydinar <65243233+fiftydinar@users.noreply.github.com> Date: Tue, 1 Oct 2024 14:35:29 +0200 Subject: [PATCH] docs: Reorder code rules to fit better --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 446c9ae..ba93d0d 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ These are general guidelines for writing official bash modules and their documen - Use `snake_case` for functions and variables changed by the code. You can utilize `readonly (-f) snake_case` to mark variable or function as read-only when it won't be changed anymore. - Use `readonly SCREAMING_SNAKE_CASE` for variables that are set once and stay unchanged. +- For functions that are set once and stay unchanged, make a function & in next line set: `readonly -f function_name`. - Use `"${variable_name}"` when you want to expose information from the variable & to ensure that variables are properly parsed as strings. - If you want to insert another regular string as a suffix or prefix to the `"${variable_name}"`, you should do that in this format: `"prefix-${variable_name}-suffix"` -- For functions that are set once and stay unchanged, make a function & in next line set: `readonly -f function_name` - Use `set -euo pipefail` at the start of the script, to ensure that module will fail the image build if error is caught. - You can also use `set -euxo pipefail` during debugging, where each executed command is printed. This should not be used in a published module. - For downloading files, we utilize `curl`. Here's the template for what we're using: