From 24914e66439c7f7059a00ea502660cdd4f8acf72 Mon Sep 17 00:00:00 2001 From: soridalac Date: Fri, 30 Oct 2026 14:43:52 -0700 Subject: [PATCH 1/7] chore: add missing OSS compliance files --- CODEOWNERS | 2 + CONTRIBUTING.md | 42 ++++++++++++++++++ DEVELOPING.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 156 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 DEVELOPING.md diff --git a/CODEOWNERS b/CODEOWNERS index 0ded67a..37df268 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -3,3 +3,5 @@ # Comment line immediately above ownership line is reserved for related other information. Please be careful while editing. #ECCN:Open Source +#GUSINFO:Platform CLI,Platform CLI +* @salesforcecli/cli diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0136f61 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +## Contributing + +1. The [DEVELOPING](DEVELOPING.md) doc has details on how to set up your environment. +1. Create a new issue before starting your project so that we can keep track of + what you are trying to add/fix. That way, we can also offer suggestions or + let you know if there is already an effort in progress. +1. Fork this repository (external contributors) or branch off main (committers). +1. Create a _topic_ branch in your fork based on the main branch. Note, this step is recommended but technically not required if contributing using a fork. +1. Edit the code in your fork/branch. +1. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without associated tests. +1. Sign CLA (see [CLA](#cla) below). +1. Send us a pull request when you are done. We'll review your code, suggest any + needed changes, and merge it in. +1. Upon merge, a new release of the `@salesforce/plugin-api` plugin will be published to npmjs with a version bump corresponding to the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/). + - To increase the patch version, make sure that at least 1 commit message starts with "fix:" + - To increase the minor version, make sure that at least 1 commit message starts with "feat:" + - To bump the major version, please work with the CLI team. + +### CLA + +External contributors will be required to sign a Contributor's License +Agreement. You can do so by going to https://cla.salesforce.com/sign-cla. + +## Branches + +- We work in branches off of `main`. +- Our released (aka. _production_) branch is `main`. +- Our work happens in _topic_ branches (feature and/or bug-fix). + - feature as well as bug-fix branches are based on `main` + - branches _should_ be kept up-to-date using `rebase` + - [commit messages are enforced](DEVELOPING.md#When-you-are-ready-to-commit) + +## Pull Requests + +- Develop features and bug fixes in _topic_ branches off main, or forks. +- _Topic_ branches can live in forks (external contributors) or within this repository (committers). + \*\* When creating _topic_ branches in this repository please prefix with `/`. +- PRs will be reviewed and merged by committers. + +## Releasing + +- A new version of this plugin (`@salesforce/plugin-api`) will be published upon merging PRs to `main`, with the version number increment based on commitizen rules. diff --git a/DEVELOPING.md b/DEVELOPING.md new file mode 100644 index 0000000..467abb9 --- /dev/null +++ b/DEVELOPING.md @@ -0,0 +1,112 @@ +# Developing + +## Table of Contents + +[One-time Setup](#one-time-setup)
+[Quick Start](#quick-start)
+[Testing](#testing)
+[Debugging](#debugging)
+[Running Commands](#running-commands)
+[When you are ready to commit](#When-you-are-ready-to-commit)
+[Useful Yarn Commands](#useful-yarn-commands)
+ +
+ +## One-time Setup + +1. Install NodeJS. If you need to work with multiple versions of Node, you + might consider using [nvm](https://github.com/creationix/nvm).
_Suggestion: use the current [LTS version of node](https://github.com/nodejs/release#release-schedule)._ +1. Install [yarn](https://yarnpkg.com/) to manage node dependencies.
_Suggestion: install yarn globally using `npm install --global yarn`_ +1. Clone this repository from git. E.g., (ssh):
`git clone git@github.com:salesforcecli/plugin-api.git` +1. Configure [git commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). + +## Quick Start + +1. `cd` into the `plugin-api` directory +1. Checkout the main branch: `git checkout main` +1. Get all latest changes: `git pull` +1. Download NPM dependencies: `yarn install`. If it's been a while since you last did this you may want to run `yarn clean-all` before this step. +1. Build and lint the code: `yarn build` +1. Create a branch off main for new work: `git checkout -b ` _Suggestion: use branch_name format of initials/work-title_. For external contributors, please fork the main branch of the repo instead and PR the fork to the main branch. +1. Make code changes and build: `yarn build` +1. Run changed commands: e.g., `./bin/run.js -h` +1. Write tests and run: `yarn test` (unit) and/or `yarn test:nuts` (NUTs) +1. Show all changed files: `git status` +1. Add all files to staging: `git add .` +1. Commit staged files with helpful commit message following the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/).: `git commit` + - See [When you are ready to commit](#When-you-are-ready-to-commit) +1. Push commit(s) to remote: `git push -u origin ` +1. Create a pull request (PR) using the GitHub UI [here](https://github.com/salesforcecli/plugin-api). + +## Testing + +All changes must have associated tests. This library uses a combination of unit testing and NUTs (non-unit tests). + +### Unit tests + +Unit tests are run with `yarn test` and use the mocha test framework. Tests are located in the test directory and are named with the pattern, `.test.ts`. Reference the existing unit tests when writing and testing code changes. + +### NUTs (non-unit tests) + +Non-unit tests are run with `yarn test:nuts` and use the [cli-plugin-testkit](https://github.com/salesforcecli/cli-plugins-testkit) framework. These tests run using the default devhub in your environment. NUTs are a way to test the library code in a real environment versus a unit test environment where many things are stubbed. + +## Debugging + +If you need to debug plugin code or tests you should refer to the excellent documentation on this topic in the [Plugin Developer Guide](https://github.com/salesforcecli/cli/wiki/Debug-Your-Plugin). + +## Running Commands + +To run your modified plugin commands locally, use `./bin/run.js` or `./bin/run.cmd` (Windows). Note that you must compile any code changes (`yarn compile`) before seeing those changes with `./bin/run.js`. + +```bash +# Run using local script. +./bin/run.js --help +``` + +There should be no differences when running via the Salesforce CLI or using the local scripts. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine. + +```bash +# Link your plugin to the sf cli +sf plugins:link . +# To verify +sf plugins +``` + +## When you are ready to commit + +If you want your changes to be published to npmjs, your commit messages must follow the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/). + +- To increase the patch version, make sure that at least 1 commit message starts with "fix:" +- To increase the minor version, make sure that at least 1 commit message starts with "feat:" +- To bump the major version, please work with the CLI team. + If you'd like a review from a CLI developer, please tag us in Slack or in the PR. + +## Useful yarn commands + +#### `yarn install` + +This downloads all NPM dependencies into the node_modules directory. + +#### `yarn compile` + +This compiles the typescript to javascript. + +#### `yarn lint` + +This lints all the typescript using eslint. + +#### `yarn build` + +This compiles and lints all the typescript (e.g., `yarn compile && yarn lint`). + +#### `yarn clean` + +This cleans all generated files and directories. Run `yarn clean-all` to also clean up the node_module directories. + +#### `yarn test` + +This runs unit tests (mocha) for the project using ts-node. + +#### `yarn test:nuts` + +This runs NUTs (non-unit tests) for the project using ts-node. From 8958c739cb0eb6873e81d90cd8ce8884f6a7f240 Mon Sep 17 00:00:00 2001 From: soridalac Date: Mon, 2 Nov 2026 14:29:42 -0800 Subject: [PATCH 2/7] fix: update md file --- CONTRIBUTING.md | 46 +++++++++----------- DEVELOPING.md | 112 ------------------------------------------------ README.md | 23 ++-------- 3 files changed, 25 insertions(+), 156 deletions(-) delete mode 100644 DEVELOPING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0136f61..29fa85f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,42 +1,38 @@ ## Contributing -1. The [DEVELOPING](DEVELOPING.md) doc has details on how to set up your environment. -1. Create a new issue before starting your project so that we can keep track of - what you are trying to add/fix. That way, we can also offer suggestions or - let you know if there is already an effort in progress. -1. Fork this repository (external contributors) or branch off main (committers). -1. Create a _topic_ branch in your fork based on the main branch. Note, this step is recommended but technically not required if contributing using a fork. -1. Edit the code in your fork/branch. -1. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without associated tests. -1. Sign CLA (see [CLA](#cla) below). -1. Send us a pull request when you are done. We'll review your code, suggest any - needed changes, and merge it in. -1. Upon merge, a new release of the `@salesforce/plugin-api` plugin will be published to npmjs with a version bump corresponding to the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/). - - To increase the patch version, make sure that at least 1 commit message starts with "fix:" - - To increase the minor version, make sure that at least 1 commit message starts with "feat:" - - To bump the major version, please work with the CLI team. +1. Please create a new issue [here](https://github.com/forcedotcom/cli/issues) before starting any work so that we can also offer suggestions or let you know if there is already an effort in progress. +1. Sign the Salesforce [CLA](#cla). +1. The CLI team will review your pull request and provide feedback. +1. Once merged, a new release of `@salesforce/plugin-api` will be published to [npm](https://www.npmjs.com/package/@salesforce/plugin-api). ### CLA -External contributors will be required to sign a Contributor's License +External contributors are required to sign a Contributor License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla. ## Branches - We work in branches off of `main`. -- Our released (aka. _production_) branch is `main`. +- Our release (aka. _production_) branch is `main`. - Our work happens in _topic_ branches (feature and/or bug-fix). - - feature as well as bug-fix branches are based on `main` - - branches _should_ be kept up-to-date using `rebase` - - [commit messages are enforced](DEVELOPING.md#When-you-are-ready-to-commit) + - Feature as well as bug-fix branches are based on `main` + - Branches _should_ be kept up-to-date using `rebase` ## Pull Requests - Develop features and bug fixes in _topic_ branches off main, or forks. -- _Topic_ branches can live in forks (external contributors) or within this repository (committers). - \*\* When creating _topic_ branches in this repository please prefix with `/`. -- PRs will be reviewed and merged by committers. +- _Topic_ branches can live in forks (external contributors) or within this repository (internal contributors). + - When creating _topic_ branches in this repository please prefix with `/`. For example: `mb/refactor-tests`. +- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) to drive semver versioning. Examples: + - `chore: my chore message` --> No release + - `fix: my fix message` --> Patch release + - `feat: my feat message` --> Minor release +- PRs will be reviewed and merged by the CLI team. -## Releasing +## Testing -- A new version of this plugin (`@salesforce/plugin-api`) will be published upon merging PRs to `main`, with the version number increment based on commitizen rules. +All changes must have associated tests. This plugin uses a combination of unit testing and NUTs (non-unit tests). Refer to the [Salesforce CLI Plugin Developer Guide](https://developer.salesforce.com/docs/platform/salesforce-cli-plugin/guide/test-plugin.html) for testing details. + +## Debugging + +Refer to the [Salesforce CLI Plugin Developer Guide](https://developer.salesforce.com/docs/platform/salesforce-cli-plugin/guide/debug-plugin.html) for debugging tips. diff --git a/DEVELOPING.md b/DEVELOPING.md deleted file mode 100644 index 467abb9..0000000 --- a/DEVELOPING.md +++ /dev/null @@ -1,112 +0,0 @@ -# Developing - -## Table of Contents - -[One-time Setup](#one-time-setup)
-[Quick Start](#quick-start)
-[Testing](#testing)
-[Debugging](#debugging)
-[Running Commands](#running-commands)
-[When you are ready to commit](#When-you-are-ready-to-commit)
-[Useful Yarn Commands](#useful-yarn-commands)
- -
- -## One-time Setup - -1. Install NodeJS. If you need to work with multiple versions of Node, you - might consider using [nvm](https://github.com/creationix/nvm).
_Suggestion: use the current [LTS version of node](https://github.com/nodejs/release#release-schedule)._ -1. Install [yarn](https://yarnpkg.com/) to manage node dependencies.
_Suggestion: install yarn globally using `npm install --global yarn`_ -1. Clone this repository from git. E.g., (ssh):
`git clone git@github.com:salesforcecli/plugin-api.git` -1. Configure [git commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). - -## Quick Start - -1. `cd` into the `plugin-api` directory -1. Checkout the main branch: `git checkout main` -1. Get all latest changes: `git pull` -1. Download NPM dependencies: `yarn install`. If it's been a while since you last did this you may want to run `yarn clean-all` before this step. -1. Build and lint the code: `yarn build` -1. Create a branch off main for new work: `git checkout -b ` _Suggestion: use branch_name format of initials/work-title_. For external contributors, please fork the main branch of the repo instead and PR the fork to the main branch. -1. Make code changes and build: `yarn build` -1. Run changed commands: e.g., `./bin/run.js -h` -1. Write tests and run: `yarn test` (unit) and/or `yarn test:nuts` (NUTs) -1. Show all changed files: `git status` -1. Add all files to staging: `git add .` -1. Commit staged files with helpful commit message following the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/).: `git commit` - - See [When you are ready to commit](#When-you-are-ready-to-commit) -1. Push commit(s) to remote: `git push -u origin ` -1. Create a pull request (PR) using the GitHub UI [here](https://github.com/salesforcecli/plugin-api). - -## Testing - -All changes must have associated tests. This library uses a combination of unit testing and NUTs (non-unit tests). - -### Unit tests - -Unit tests are run with `yarn test` and use the mocha test framework. Tests are located in the test directory and are named with the pattern, `.test.ts`. Reference the existing unit tests when writing and testing code changes. - -### NUTs (non-unit tests) - -Non-unit tests are run with `yarn test:nuts` and use the [cli-plugin-testkit](https://github.com/salesforcecli/cli-plugins-testkit) framework. These tests run using the default devhub in your environment. NUTs are a way to test the library code in a real environment versus a unit test environment where many things are stubbed. - -## Debugging - -If you need to debug plugin code or tests you should refer to the excellent documentation on this topic in the [Plugin Developer Guide](https://github.com/salesforcecli/cli/wiki/Debug-Your-Plugin). - -## Running Commands - -To run your modified plugin commands locally, use `./bin/run.js` or `./bin/run.cmd` (Windows). Note that you must compile any code changes (`yarn compile`) before seeing those changes with `./bin/run.js`. - -```bash -# Run using local script. -./bin/run.js --help -``` - -There should be no differences when running via the Salesforce CLI or using the local scripts. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine. - -```bash -# Link your plugin to the sf cli -sf plugins:link . -# To verify -sf plugins -``` - -## When you are ready to commit - -If you want your changes to be published to npmjs, your commit messages must follow the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/). - -- To increase the patch version, make sure that at least 1 commit message starts with "fix:" -- To increase the minor version, make sure that at least 1 commit message starts with "feat:" -- To bump the major version, please work with the CLI team. - If you'd like a review from a CLI developer, please tag us in Slack or in the PR. - -## Useful yarn commands - -#### `yarn install` - -This downloads all NPM dependencies into the node_modules directory. - -#### `yarn compile` - -This compiles the typescript to javascript. - -#### `yarn lint` - -This lints all the typescript using eslint. - -#### `yarn build` - -This compiles and lints all the typescript (e.g., `yarn compile && yarn lint`). - -#### `yarn clean` - -This cleans all generated files and directories. Run `yarn clean-all` to also clean up the node_module directories. - -#### `yarn test` - -This runs unit tests (mocha) for the project using ts-node. - -#### `yarn test:nuts` - -This runs NUTs (non-unit tests) for the project using ts-node. diff --git a/README.md b/README.md index 8189223..d2f012d 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,7 @@ Please report any issues at https://github.com/forcedotcom/cli/issues ## Contributing -1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md) -2. Create a new issue before starting your project so that we can keep track of - what you are trying to add/fix. That way, we can also offer suggestions or - let you know if there is already an effort in progress. -3. Fork this repository. -4. [Build the plugin locally](#build) -5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork. -6. Edit the code in your fork. -7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests. -8. Sign CLA (see [CLA](#cla) below). -9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in. - -### CLA - -External contributors will be required to sign a Contributor's License -Agreement. You can do so by going to https://cla.salesforce.com/sign-cla. +If you're interested in contributing, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide. ### Build @@ -33,17 +18,17 @@ To build the plugin locally, make sure to have yarn installed and run the follow ```bash # Clone the repository -git clone git@github.com:salesforcecli/plugin-template-sf +git clone git@github.com:salesforcecli/plugin-api # Install the dependencies and compile yarn && yarn build ``` -To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file. +To use your plugin, run using the local `./bin/run.js` file. ```bash # Run using local run file. -./bin/dev hello world +./bin/run.js api request rest '/services/data/v62.0/limits' -o myOrg@example.com ``` There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine. From c8ebad560c02128d1eeb344593ea2cd64b847645 Mon Sep 17 00:00:00 2001 From: soridalac Date: Mon, 2 Nov 2026 15:52:13 -0800 Subject: [PATCH 3/7] fix: update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d2f012d..5fdc2a8 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,11 @@ git clone git@github.com:salesforcecli/plugin-api yarn && yarn build ``` -To use your plugin, run using the local `./bin/run.js` file. +To use your plugin, run using the local `./bin/dev.js` or `./bin/dev.cmd` file. ```bash # Run using local run file. -./bin/run.js api request rest '/services/data/v62.0/limits' -o myOrg@example.com +./bin/dev.js api request rest '/services/data/v62.0/limits' -o myOrg@example.com ``` There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine. From afabac39db2fc112adaa7411b34a0cf2400395bd Mon Sep 17 00:00:00 2001 From: soridalac Date: Mon, 2 Nov 2026 17:18:39 -0800 Subject: [PATCH 4/7] chore: update OSS compliance files Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29fa85f..b903cf6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ ## Contributing 1. Please create a new issue [here](https://github.com/forcedotcom/cli/issues) before starting any work so that we can also offer suggestions or let you know if there is already an effort in progress. +1. Fork this repository. 1. Sign the Salesforce [CLA](#cla). 1. The CLI team will review your pull request and provide feedback. 1. Once merged, a new release of `@salesforce/plugin-api` will be published to [npm](https://www.npmjs.com/package/@salesforce/plugin-api). @@ -31,8 +32,38 @@ Agreement. You can do so by going to https://cla.salesforce.com/sign-cla. ## Testing -All changes must have associated tests. This plugin uses a combination of unit testing and NUTs (non-unit tests). Refer to the [Salesforce CLI Plugin Developer Guide](https://developer.salesforce.com/docs/platform/salesforce-cli-plugin/guide/test-plugin.html) for testing details. +All changes must have associated tests. This plugin uses a combination of unit testing and NUTs (non-unit tests). + +- Run unit tests with `yarn test`. Tests use the mocha framework and are located in the `test` directory with the naming pattern `.test.ts`. +- Run integration tests (NUTs) with `yarn test:nuts`. NUTs use the [cli-plugins-testkit](https://github.com/salesforcecli/cli-plugins-testkit) framework and run against the default devhub in your environment. ## Debugging Refer to the [Salesforce CLI Plugin Developer Guide](https://developer.salesforce.com/docs/platform/salesforce-cli-plugin/guide/debug-plugin.html) for debugging tips. + +## Local Development + +To run modified plugin commands locally, use `./bin/run.js` or `./bin/run.cmd` (Windows). Changes must be compiled with `yarn build` before they take effect. Use `yarn build --watch` to automatically recompile when files are saved. + +```bash +# Compile changes +yarn build + +# Run a command locally +./bin/run.js --help +``` + +To link the plugin to the Salesforce CLI for testing: + +```bash +sf plugins link . +sf plugins # verify +``` + +## Useful Yarn Commands + +- `yarn build` — Compile the TypeScript source +- `yarn build --watch` — Recompile automatically on file changes +- `yarn test` — Run unit tests +- `yarn test:nuts` — Run integration tests (NUTs) +- `yarn lint` — Run the linter From 7e8a44ca77239cef7bc19bca733f1e055e4ec08d Mon Sep 17 00:00:00 2001 From: soridalac Date: Mon, 2 Nov 2026 17:42:51 -0800 Subject: [PATCH 5/7] chore: update OSS compliance files Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 30 ++++++++++-------------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b903cf6..7914fff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,20 @@ ## Contributing 1. Please create a new issue [here](https://github.com/forcedotcom/cli/issues) before starting any work so that we can also offer suggestions or let you know if there is already an effort in progress. -1. Fork this repository. +1. Fork this repository (external contributors) or branch off `main` (committers). +1. Create a topic branch based on `main`. This is recommended but not required if contributing using a fork. +1. Edit the code in your fork/branch. +1. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without associated tests. 1. Sign the Salesforce [CLA](#cla). 1. The CLI team will review your pull request and provide feedback. 1. Once merged, a new release of `@salesforce/plugin-api` will be published to [npm](https://www.npmjs.com/package/@salesforce/plugin-api). +### One-Time Setup + +1. Install [Node.js](https://nodejs.org). Use the version specified in the `engines` field of package.json. If you work with multiple Node versions, consider using [nvm](https://github.com/nvm-sh/nvm). +1. Install [Yarn](https://yarnpkg.com): `npm install --global yarn` +1. Configure [git commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification). + ### CLA External contributors are required to sign a Contributor License @@ -41,25 +50,6 @@ All changes must have associated tests. This plugin uses a combination of unit t Refer to the [Salesforce CLI Plugin Developer Guide](https://developer.salesforce.com/docs/platform/salesforce-cli-plugin/guide/debug-plugin.html) for debugging tips. -## Local Development - -To run modified plugin commands locally, use `./bin/run.js` or `./bin/run.cmd` (Windows). Changes must be compiled with `yarn build` before they take effect. Use `yarn build --watch` to automatically recompile when files are saved. - -```bash -# Compile changes -yarn build - -# Run a command locally -./bin/run.js --help -``` - -To link the plugin to the Salesforce CLI for testing: - -```bash -sf plugins link . -sf plugins # verify -``` - ## Useful Yarn Commands - `yarn build` — Compile the TypeScript source From d6c19e3b0911693bf70d10726dee5e7030d145b8 Mon Sep 17 00:00:00 2001 From: soridalac Date: Tue, 3 Nov 2026 09:14:57 -0800 Subject: [PATCH 6/7] chore: update OSS compliance files Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7914fff..a19ff57 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,9 @@ ## Contributing +1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md). 1. Please create a new issue [here](https://github.com/forcedotcom/cli/issues) before starting any work so that we can also offer suggestions or let you know if there is already an effort in progress. 1. Fork this repository (external contributors) or branch off `main` (committers). +1. [Build the plugin locally](README.md#build). 1. Create a topic branch based on `main`. This is recommended but not required if contributing using a fork. 1. Edit the code in your fork/branch. 1. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without associated tests. From 89307b0781da233875708d717ed2241a06da8aa9 Mon Sep 17 00:00:00 2001 From: soridalac Date: Tue, 3 Nov 2026 10:35:54 -0800 Subject: [PATCH 7/7] chore: update OSS compliance files Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a19ff57..b599be7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ ### One-Time Setup 1. Install [Node.js](https://nodejs.org). Use the version specified in the `engines` field of package.json. If you work with multiple Node versions, consider using [nvm](https://github.com/nvm-sh/nvm). -1. Install [Yarn](https://yarnpkg.com): `npm install --global yarn` +1. Install [Yarn v1](https://classic.yarnpkg.com): `npm install --global yarn` 1. Configure [git commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification). ### CLA