From 3ec80a131142f0ead8f21afdfd193f6ee2edf2f7 Mon Sep 17 00:00:00 2001 From: soridalac Date: Fri, 30 Oct 2026 14:50:00 -0700 Subject: [PATCH 1/6] chore: add missing OSS compliance files --- CODEOWNERS | 2 + CODE_OF_CONDUCT.md | 105 ++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 42 +++++++++++++++++ DEVELOPING.md | 112 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 261 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 DEVELOPING.md diff --git a/CODEOWNERS b/CODEOWNERS index 0ded67ad..37df2687 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/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..7f547bd2 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,105 @@ +# Salesforce Open Source Community Code of Conduct + +## About the Code of Conduct + +Equality is a core value at Salesforce. We believe a diverse and inclusive +community fosters innovation and creativity, and are committed to building a +culture where everyone feels included. + +Salesforce open-source projects are committed to providing a friendly, safe, and +welcoming environment for all, regardless of gender identity and expression, +sexual orientation, disability, physical appearance, body size, ethnicity, nationality, +race, age, religion, level of experience, education, socioeconomic status, or +other similar personal characteristics. + +The goal of this code of conduct is to specify a baseline standard of behavior so +that people with different social values and communication styles can work +together effectively, productively, and respectfully in our open source community. +It also establishes a mechanism for reporting issues and resolving conflicts. + +All questions and reports of abusive, harassing, or otherwise unacceptable behavior +in a Salesforce open-source project may be reported by contacting the Salesforce +Open Source Conduct Committee at ossconduct@salesforce.com. + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of gender +identity and expression, sexual orientation, disability, physical appearance, +body size, ethnicity, nationality, race, age, religion, level of experience, education, +socioeconomic status, or other similar personal characteristics. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy toward other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Personal attacks, insulting/derogatory comments, or trolling +- Public or private harassment +- Publishing, or threatening to publish, others' private information—such as + a physical or electronic address—without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting +- Advocating for or encouraging any of the above behaviors + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned with this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project email +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the Salesforce Open Source Conduct Committee +at ossconduct@salesforce.com. All complaints will be reviewed and investigated +and will result in a response that is deemed necessary and appropriate to the +circumstances. The committee is obligated to maintain confidentiality with +regard to the reporter of an incident. Further details of specific enforcement +policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership and the Salesforce Open Source Conduct +Committee. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][contributor-covenant-home], +version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. +It includes adaptions and additions from [Go Community Code of Conduct][golang-coc], +[CNCF Code of Conduct][cncf-coc], and [Microsoft Open Source Code of Conduct][microsoft-coc]. + +This Code of Conduct is licensed under the [Creative Commons Attribution 3.0 License][cc-by-3-us]. + +[contributor-covenant-home]: https://www.contributor-covenant.org 'https://www.contributor-covenant.org/' +[golang-coc]: https://golang.org/conduct +[cncf-coc]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md +[microsoft-coc]: https://opensource.microsoft.com/codeofconduct/ +[cc-by-3-us]: https://creativecommons.org/licenses/by/3.0/us/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..561fa40a --- /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-command-reference` 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-command-reference`) 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 00000000..ff7ea6ab --- /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-command-reference.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-command-reference` 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-command-reference). + +## 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 b8cb302cc3969af8435f880b7e1de444547a4d64 Mon Sep 17 00:00:00 2001 From: soridalac Date: Mon, 2 Nov 2026 14:35:59 -0800 Subject: [PATCH 2/6] fix: update md files --- CONTRIBUTING.md | 46 +++++++++----------- DEVELOPING.md | 112 ------------------------------------------------ README.md | 4 ++ 3 files changed, 25 insertions(+), 137 deletions(-) delete mode 100644 DEVELOPING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 561fa40a..1ac55c39 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-command-reference` 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-command-reference` will be published to [npm](https://www.npmjs.com/package/@salesforce/plugin-command-reference). ### 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-command-reference`) 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 ff7ea6ab..00000000 --- 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-command-reference.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-command-reference` 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-command-reference). - -## 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 4538f0bc..c57c9ae3 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,10 @@ Then you can run this in your plugin's CI. ./bin/dev commandreference --plugins --error-on-warnings ``` +## Contributing + +If you're interested in contributing, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide. + ## Local Development If you need to make changes to this repository, the easiest thing to do is to link it to your Salesforce CLI. After you cloned this plugin, run the following from this plugin directory: From a31fa0822c474d7df6aaea942d5f67c557232f5d Mon Sep 17 00:00:00 2001 From: soridalac Date: Mon, 2 Nov 2026 17:18:52 -0800 Subject: [PATCH 3/6] 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 1ac55c39..c183e3c9 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-command-reference` will be published to [npm](https://www.npmjs.com/package/@salesforce/plugin-command-reference). @@ -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 4862a9de3aef6b82e2f9425bda751ea76d9961a5 Mon Sep 17 00:00:00 2001 From: soridalac Date: Mon, 2 Nov 2026 17:43:04 -0800 Subject: [PATCH 4/6] 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 c183e3c9..3059f646 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-command-reference` will be published to [npm](https://www.npmjs.com/package/@salesforce/plugin-command-reference). +### 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 8eff650e288199dd1b6130ed0211441754081350 Mon Sep 17 00:00:00 2001 From: soridalac Date: Tue, 3 Nov 2026 10:36:10 -0800 Subject: [PATCH 5/6] chore: update OSS compliance files Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3059f646..a1bbeffd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,6 @@ ## 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. Create a topic branch based on `main`. This is recommended but not required if contributing using a fork. @@ -12,7 +13,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 From b6d63b53ce1218577d578673451b4e3f8c5e6f95 Mon Sep 17 00:00:00 2001 From: Sorida <96142310+soridalac@users.noreply.github.com> Date: Tue, 3 Nov 2026 13:56:47 -0800 Subject: [PATCH 6/6] fix: Update CONTRIBUTING.md to remove NUTs reference Removed mention of integration tests (NUTs) from the documentation. --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1bbeffd..cf09ad8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,10 +42,9 @@ 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). +All changes must have associated 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 @@ -56,5 +55,4 @@ Refer to the [Salesforce CLI Plugin Developer Guide](https://developer.salesforc - `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