903 B
Formatting Guidelines
All files should adhere to these formatting guidelines.
Script
-
All
build.sh
should be set to644
permission. -
All scripts should use tabs rather than spaces.
-
All parantheses of shell functions should not be preceded with a space.
-
Dollar parentheses
$()
rather than backticks``
should be employed in command substitution.
Markdown
-
All
filenames
should be under code formatting, unless they are links. -
All titles should be indented with hashes rather than equal signs.
-
All unnumbered lists should be indented with hyphens.
-
All Markdown should be edited on alternate line.
-
All Markdown should use tabs rather than spaces.
-
All
.md
should be set to644
permission. -
All characters should be escaped.
-
All names of
.md
should be capitalised. -
All code blocks should be enclosed in backticks, with language specified.