From 9e4d68be52cb9bca0f98afb3af92018a7e10e7f4 Mon Sep 17 00:00:00 2001 From: soridalac Date: Tue, 3 Nov 2026 11:14:41 -0800 Subject: [PATCH 1/3] chore: update OSS compliance files --- CONTRIBUTING.md | 48 ++++++++++++++++++++---------------------------- README.md | 4 ++-- 2 files changed, 22 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34cfddec..5780b0e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,42 +1,34 @@ ## 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. -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. -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 unit 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. 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. +1. Edit the code in your fork/branch. +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/cli-plugins-testkit` will be published to [npm](https://www.npmjs.com/package/@salesforce/cli-plugins-testkit). ### 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) - - see below for further merge instructions - -### Releasing - -- A new version of this library will be published upon merging PRs to `main`, with the version number increment based on commitizen. + - 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. -- _Topic_ branches can live in forks (external contributors) or within this repository (committers). - \*\* When creating _topic_ branches in this repository please prefix with `/`. - -### Merging Pull Requests - -- Pull request merging is restricted to squash & merge only. +- Develop features and bug fixes in _topic_ branches off main, or forks. +- _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. diff --git a/README.md b/README.md index 21acd686..61f695b0 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Although oclif provides a way to run commands locally using the local `bin/run` ```typescript import { exec } from 'shelljs'; -const result = exec('./bin/run mycommand --myflag --json'); +const result = exec('./bin/run.js mycommand --myflag --json'); console.log(JSON.parse(result.stdout)); ``` @@ -64,7 +64,7 @@ expect(result.name).to.equal('expectedName'); npm install @salesforce/cli@latest-rc # Install the newly published version of my plugin -./node_modules/.bin/sf plugins:install myplugin +./node_modules/.bin/sf plugins install myplugin # Target the local sf export TESTKIT_EXECUTABLE_PATH=./node_modules/.bin/sf From ec2fbb6a1f1b354ac4168e7ed9e7a9ea766d8c1a Mon Sep 17 00:00:00 2001 From: soridalac Date: Tue, 3 Nov 2026 13:36:16 -0800 Subject: [PATCH 2/3] fix: add CODEOWNERS --- CODEOWNERS | 2 ++ 1 file changed, 2 insertions(+) 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 From 7ffa9e4a6fc2d4e4997ad05ad3a54c32b1dd1d45 Mon Sep 17 00:00:00 2001 From: soridalac Date: Tue, 3 Nov 2026 13:38:53 -0800 Subject: [PATCH 3/3] chore: restore CONTRIBUTING.md and README.md to main Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++-------------------- README.md | 4 ++-- 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5780b0e7..34cfddec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,34 +1,42 @@ ## 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. -1. Edit the code in your fork/branch. -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/cli-plugins-testkit` will be published to [npm](https://www.npmjs.com/package/@salesforce/cli-plugins-testkit). +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. +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. +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 unit 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. ### CLA -External contributors are required to sign a Contributor License +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 release (aka. _production_) branch is `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` + - 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) + - see below for further merge instructions + +### Releasing + +- A new version of this library will be published upon merging PRs to `main`, with the version number increment based on commitizen. ## 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 (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. +- Develop features and bug fixes in _topic_ branches. +- _Topic_ branches can live in forks (external contributors) or within this repository (committers). + \*\* When creating _topic_ branches in this repository please prefix with `/`. + +### Merging Pull Requests + +- Pull request merging is restricted to squash & merge only. diff --git a/README.md b/README.md index 61f695b0..21acd686 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Although oclif provides a way to run commands locally using the local `bin/run` ```typescript import { exec } from 'shelljs'; -const result = exec('./bin/run.js mycommand --myflag --json'); +const result = exec('./bin/run mycommand --myflag --json'); console.log(JSON.parse(result.stdout)); ``` @@ -64,7 +64,7 @@ expect(result.name).to.equal('expectedName'); npm install @salesforce/cli@latest-rc # Install the newly published version of my plugin -./node_modules/.bin/sf plugins install myplugin +./node_modules/.bin/sf plugins:install myplugin # Target the local sf export TESTKIT_EXECUTABLE_PATH=./node_modules/.bin/sf