From f37c968e4e37c667474c8a0f116a3e38e1223de2 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Wed, 26 Jan 2022 02:00:40 -0700 Subject: [PATCH] docs: update CONTRIBUTING guidelines --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 321a47e..bf9b099 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,12 +8,22 @@ **Before you PR**: -- You'll be asked to make changes if you don't code formatters and linters: +- You'll be asked to make changes if you don't run the code formatters and + linters: - Node / JavaScript: - [prettier](https://webinstall.dev/prettier) + ```bash + npm run prettier + ``` - [jshint](https://webinstall.dev/jshint) + ```bash + npm run lint + ``` - Bash - [shfmt](https://webinstall.dev/shfmt) + ```bash + npm run shfmt + ``` - [shellcheck](https://webinstall.dev/shellcheck) - If you use vim, [vim-essentials](https://webinstall.dev/vim-essentials) includes everything you need to automatically format and lint on save.