Skip to content

Commit

Permalink
docs: update contributing toolbelt
Browse files Browse the repository at this point in the history
  • Loading branch information
scolladon committed Oct 6, 2024
1 parent d0c1dbf commit 3339f8d
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 [sfcli parameters convention](https://github.com/salesforcecli/cli/wiki/Design-Guidelines-Flags) to define parameters for the CLI.

## Testing the plugin from a pull request

Expand Down

0 comments on commit 3339f8d

Please sign in to comment.