diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9655abfd..c60fa9a5 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, 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 diff --git a/DEVELOPING.md b/DEVELOPING.md index 5b8c9995..79fe3425 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, 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`