Skip to content

Commit f81a145

Browse files
authored
Merge pull request #1109 from salesforcecli/sh/improve-md-docs
chore: update docs for conventional commits @W-20931304
2 parents c0efd1e + 924b49b commit f81a145

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@
1111
1. Sign CLA (see [CLA](#cla) below).
1212
1. Send us a pull request when you are done. We'll review your code, suggest any
1313
needed changes, and merge it in.
14-
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.
14+
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/).
15+
- To increase the patch version, make sure that at least 1 commit message starts with "fix:"
16+
- To increase the minor version, make sure that at least 1 commit message starts with "feat:"
17+
- To bump the major version, please work with the CLI team.
1518

1619
### CLA
1720

DEVELOPING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
[Debugging](#debugging)</br>
99
[Linking the Packaging Library](#linking-the-packaging-library)</br>
1010
[Running Commands](#running-commands)</br>
11+
[When you are ready to commit](#When-you-are-ready-to-commit)</br>
1112
[Useful Yarn Commands](#useful-yarn-commands)</br>
1213

1314
<hr>
@@ -33,7 +34,8 @@
3334
1. Write tests and run: `yarn test` (unit) and/or `yarn test:nuts` (NUTs)
3435
1. Show all changed files: `git status`
3536
1. Add all files to staging: `git add .`
36-
1. Commit staged files with helpful commit message: `git commit`
37+
1. Commit staged files with helpful commit message following the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/).: `git commit`
38+
- See [When you are ready to commit](#When-you-are-ready-to-commit)
3739
1. Push commit(s) to remote: `git push -u origin <branch_name>`
3840
1. Create a pull request (PR) using the GitHub UI [here](https://github.com/salesforcecli/plugin-packaging).
3941

@@ -77,6 +79,15 @@ sf plugins
7779
sf package create --help
7880
```
7981

82+
## When you are ready to commit
83+
84+
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/).
85+
86+
- To increase the patch version, make sure that at least 1 commit message starts with "fix:"
87+
- To increase the minor version, make sure that at least 1 commit message starts with "feat:"
88+
- To bump the major version, please work with the CLI team.
89+
If you'd like a review from a CLI developer, please tag us in Slack or in the PR.
90+
8091
## Useful yarn commands
8192

8293
#### `yarn install`

0 commit comments

Comments
 (0)