From 7ce14dc67a4737633083b69bd228e2cc84781af2 Mon Sep 17 00:00:00 2001 From: Steve Hetzel Date: Fri, 16 Jan 2026 12:42:33 -0700 Subject: [PATCH 1/7] chore: update docs for conventional commits --- CONTRIBUTING.md | 5 ++++- DEVELOPING.md | 13 ++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9655abfd..095b9d4d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,10 @@ 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-packaging` plugin will be published to npmjs with a version bump corresponding to commitizen rules. +1. Upon merge, a new release of the `@salesforce/plugin-packaging` 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, ensure at least 1 commit message starts with "fix:" + - To increase the minor version, ensure at least 1 commit message starts with "feat:" + - To bump the major version, please work with the CLI team. ### CLA diff --git a/DEVELOPING.md b/DEVELOPING.md index 5b8c9995..3862faf4 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -8,6 +8,7 @@ [Debugging](#debugging)
[Linking the Packaging Library](#linking-the-packaging-library)
[Running Commands](#running-commands)
+[When you are ready to commit](#When-you-are-ready-to-commit)
[Useful Yarn Commands](#useful-yarn-commands)
@@ -33,7 +34,8 @@ 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: `git commit` +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-packaging). @@ -77,6 +79,15 @@ sf plugins sf package create --help ``` +## 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, ensure at least 1 commit message starts with "fix:" +- To increase the minor version, ensure 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` From fe4d192f1342ab94d05136666ac25c9c068ee341 Mon Sep 17 00:00:00 2001 From: Steve Hetzel Date: Fri, 16 Jan 2026 13:04:20 -0700 Subject: [PATCH 2/7] Update CONTRIBUTING.md Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 095b9d4d..90288f80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ 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-packaging` 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, ensure at least 1 commit message starts with "fix:" + - To increase the patch version, make sure that at least 1 commit message starts with "fix:" - To increase the minor version, ensure at least 1 commit message starts with "feat:" - To bump the major version, please work with the CLI team. From 2e15ddd6c8a6ebabdd85cbd23e9e928b89c8a54f Mon Sep 17 00:00:00 2001 From: Steve Hetzel Date: Fri, 16 Jan 2026 13:04:29 -0700 Subject: [PATCH 3/7] Update CONTRIBUTING.md Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90288f80..c60fa9a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ needed changes, and merge it in. 1. Upon merge, a new release of the `@salesforce/plugin-packaging` 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, ensure at least 1 commit message starts with "feat:" + - 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 From 43a3a2911853cd38563888e2d3d69fa9cfd7392e Mon Sep 17 00:00:00 2001 From: Steve Hetzel Date: Fri, 16 Jan 2026 13:04:35 -0700 Subject: [PATCH 4/7] Update DEVELOPING.md Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> --- DEVELOPING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPING.md b/DEVELOPING.md index 3862faf4..026ff73b 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -83,7 +83,7 @@ sf package create --help 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, ensure at least 1 commit message starts with "fix:" +- To increase the patch version, make sure that at least 1 commit message starts with "fix:" - To increase the minor version, ensure 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. From 00347eec328342fe0f442894c9a3b29001bfe674 Mon Sep 17 00:00:00 2001 From: Steve Hetzel Date: Fri, 16 Jan 2026 13:04:45 -0700 Subject: [PATCH 5/7] Update DEVELOPING.md Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> --- DEVELOPING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPING.md b/DEVELOPING.md index 026ff73b..4752bfbe 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -84,7 +84,7 @@ sf package create --help 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, ensure at least 1 commit message starts with "feat:" +- 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. From fc3131fcb566b619ebd4a0cb3c0144e4d1768e3e Mon Sep 17 00:00:00 2001 From: Steve Hetzel Date: Fri, 16 Jan 2026 13:04:55 -0700 Subject: [PATCH 6/7] Update DEVELOPING.md Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> --- DEVELOPING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPING.md b/DEVELOPING.md index 4752bfbe..f4565f52 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -81,7 +81,7 @@ sf package create --help ## 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/). +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:" From 924b49bb85491aa76b8392449f3bbe0fcbcbf0a0 Mon Sep 17 00:00:00 2001 From: Steve Hetzel Date: Fri, 16 Jan 2026 13:05:02 -0700 Subject: [PATCH 7/7] Update DEVELOPING.md Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> --- DEVELOPING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPING.md b/DEVELOPING.md index f4565f52..79fe3425 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -86,7 +86,7 @@ If you want your changes to be published to npmjs, your commit messages must fol - 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. + If you'd like a review from a CLI developer, please tag us in Slack or in the PR. ## Useful yarn commands