Skip to content

Commit

Permalink
docs: Reorder code rules to fit better
Browse files Browse the repository at this point in the history
  • Loading branch information
fiftydinar authored Oct 1, 2024
1 parent 15d308b commit 282deb4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 282deb4

Please sign in to comment.