diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6db5bf0..08e2d81 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,19 +37,19 @@ Before making a pull request, make sure to follow below guidelines: - Try using bash builtins and string substitution as much as possible. - Use printf everywhere instead of echo. - Before adding a new logic, be sure to check the existing code. +- Make sure to add the function in appropriate section based on its operation. - Use [shfmt](https://github.com/mvdan/sh) to format the script. Use below command: - ```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. + ```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. - 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.