From 3532b70d4e510cbb9804a4e152bcad56f244aa85 Mon Sep 17 00:00:00 2001 From: labbots Date: Tue, 9 Jun 2020 19:50:55 +0100 Subject: [PATCH] update contributing.md --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08e2d81..ec65567 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,7 @@ Before making a pull request, make sure to follow below guidelines: ### Code Guidelines #### Styleguide + - Variable names must be meaningful and self-documenting. - Long variable names must be structured by underscores to improve legibility. - Global variables and constants must be ALL CAPS with underscores. (eg., INPUT_FILE) @@ -43,7 +44,7 @@ Before making a pull request, make sure to follow below guidelines: ```shell shfmt upload.sh ``` - + The repo already provides the .editorconfig file, which shfmt reads, so no need for extra flags. You can also install shfmt for various editors, refer their repo for information. Note: This is strictly necessary to maintain consistency, do not skip. @@ -51,6 +52,7 @@ Before making a pull request, make sure to follow below guidelines: - Script should pass all [shellcheck](https://www.shellcheck.net/) warnings, if not, then disable the warning and give a valid reason. #### Bashdoc guideline + The documentation is generated based on the function documentation within the script file. So ensure to follow the style so the documentation is properly generated by the generator. @@ -86,6 +88,7 @@ sample::function() { - If the function is similar to other function add a reference to function using @see tag. ### Documentation + - Refrain from making unnecessary newlines or whitespace. - Use pure markdown as much as possible, html is accepted but shouldn't be a priority. - The markdown must pass RemarkLint checks.