Formatting Guidelines
This commit is contained in:
parent
c779c69070
commit
27a8a9bf88
33
docs/FORMAT.md
Normal file
33
docs/FORMAT.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
# Formatting Guidelines
|
||||||
|
|
||||||
|
All files should adhere to these formatting guidelines.
|
||||||
|
|
||||||
|
## Script
|
||||||
|
|
||||||
|
- All `build.sh` should be set to `644` 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 to `644` permission.
|
||||||
|
|
||||||
|
- All characters should be escaped.
|
||||||
|
|
||||||
|
- All names of `.md` should be capitalised.
|
||||||
|
|
||||||
|
- All code blocks should be enclosed in backticks, with language specified.
|
Loading…
Reference in New Issue
Block a user