From d8a31de64935de00793771a50470890ae00e30ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= Date: Sun, 6 Oct 2024 18:03:29 +0200 Subject: [PATCH] docs: update contributing toolbelt --- CONTRIBUTING.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b7325cb3..7e48537fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -187,6 +187,14 @@ The above command may display lint issues not related to your changes. The recommended way to avoid lint issues is to [configure your editor](https://biomejs.dev/guides/integrate-in-vcs/) to warn you in real time as you edit the file. +the plugin lint all those things : +- typescript files +- folder structure +- plugin parameters +- plugin output +- dependencies +- dead code / configuration + Fixing all existing lint issues is a tedious task so please pitch in by fixing the ones related to the files you make changes to! #### Run tests @@ -227,11 +235,7 @@ yarn && yarn increment:apiversion ## CLI parameters convention -The CLI uses [Apache Commons CLI](https://commons.apache.org/proper/commons-cli/index.html) parameters convention to define parameters for the CLI. -When long parameter is one word then take the first character to define the short parameter. Ex: `--word` `-w` -When long parameter is many words then take the first character of the last word to define the short parameter. Ex: `--long-phrase` `-p` -When the short parameter is already taken then put the short parameter uppercase. Ex: `--with` `-W`, `--long-paragraph` `-P` -When the character you should take for the short parameter is already taken then choose another character. Explain your choice in the PR description and let's discuss it! +The plugins uses [sf cli parameters convention](https://github.com/salesforcecli/cli/wiki/Design-Guidelines-Flags) to define parameters for the CLI. ## Testing the plugin from a pull request