docs: update FORMAT.md

This commit is contained in:
Leonid Pliushch 2019-06-08 14:31:36 +03:00
parent 2062564afd
commit 5479081abe
1 changed files with 16 additions and 7 deletions

View File

@ -12,7 +12,7 @@ All files should adhere to these formatting guidelines.
- Avoid trailing spaces and tabs.
- Avoid usage of non utf-8 encoding.
- Avoid usage of non UTF-8 encoding.
- Comments should be compact. Do not tab them if not necessary.
@ -22,19 +22,26 @@ All files should adhere to these formatting guidelines.
- Do not export variables if not necessary.
- Custom variables in build.sh scripts should be defined inside functions. If you need a "global scope" variable at build time, just define it in `termux_step_pre_configure()`. If you still need to define variable outside of function, make sure that it does not use command or process substitution.
- Custom variables in build.sh scripts should be defined inside functions.
If you need a "global scope" variable at build time, just define it in
`termux_step_pre_configure()`. If you still need to define variable outside
of function, make sure that it does not use command or process substitution.
- Dollar parentheses `$()` rather than backticks ``` `` ``` should be employed in command substitution.
- Dollar parentheses `$()` rather than backticks ``` `` ``` should be employed
in command substitution.
- Usage of `sudo` or `su` in build scripts is disallowed.
- Utility `install` is preferred over `cp` as the file installation program.
- Do not hardcode version numbers. Instead, use the `$TERMUX_PKG_VERSION` and `$TERMUX_PKG_REVISION` variables.
- Do not hardcode version numbers. Instead, use the `$TERMUX_PKG_VERSION` and
`$TERMUX_PKG_REVISION` variables.
- Do not hardcode Termux prefix directory. Instead, use the `$TERMUX_PREFIX` variable.
- Do not hardcode Termux prefix directory. Instead, use the `$TERMUX_PREFIX`
variable.
- Do not hardcode Termux home directory. Instead, use the `$TERMUX_ANDROID_HOME` variable.
- Do not hardcode Termux home directory. Instead, use the `$TERMUX_ANDROID_HOME`
variable.
## Markdown Formatting
@ -42,7 +49,7 @@ All files should adhere to these formatting guidelines.
- All titles should be indented with hashes rather than equal signs.
- All unnumbered lists should be indented with hyphens.
- All unnumbered lists should be indented with hyphens.
- All Markdown should be edited on alternate line.
@ -55,3 +62,5 @@ All files should adhere to these formatting guidelines.
- All names of `.md` should be capitalised.
- All code blocks should be enclosed in backticks, with language specified.
- Lines shouldn't be longer than 80 characters.