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)