File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -62,7 +62,7 @@ The linter can be run locally using `composer lint`.
6262
6363[ PHP Parallel Lint ] : https://github.com/php-parallel-lint/PHP-Parallel-Lint
6464
65- ## Coding Style
65+ ## PHP Coding Style
6666
6767Please follow the existing coding style and best practices.
6868This project uses [ PHP_CodeSniffer] [ ] to detect coding standard violations and apply automated fixes (whenever possible).
@@ -72,6 +72,19 @@ This project uses [PHP_CodeSniffer][] to detect coding standard violations and a
7272
7373[ PHP_CodeSniffer ] : https://github.com/squizlabs/PHP_CodeSniffer
7474
75+ ## Shell script QA & Coding Style
76+
77+ All shell scripts used in this project are, and should be, located in the ` /scripts ` directory.
78+
79+ Please follow the existing coding style and best practices.
80+ This project uses [ ShellCheck] [ ] to detect violations.
81+
82+ * Shellcheck can be [ installed on all platforms] [ shellcheck-install ]
83+ * All files can be checked for coding standard violations by running ` shellcheck ` .
84+
85+ [ ShellCheck ] : https://github.com/koalaman/shellcheck
86+ [ shellcheck-install ] : https://github.com/koalaman/shellcheck#user-content-installing
87+
7588## Unit Tests
7689
7790PRs should include unit tests for all changes.
Original file line number Diff line number Diff line change 1+ shell =bash
2+ color =always
3+
4+ external-sources =false
5+ source-path =/scripts
6+ source-path =/scripts/proxy
7+
8+ # Turn on all checks.
9+ enable =all
You can’t perform that action at this time.
0 commit comments