Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:"
Comment thread
shetzel marked this conversation as resolved.
Outdated
- To increase the minor version, ensure at least 1 commit message starts with "feat:"
Comment thread
shetzel marked this conversation as resolved.
Outdated
- To bump the major version, please work with the CLI team.

### CLA

Expand Down
13 changes: 12 additions & 1 deletion DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
[Debugging](#debugging)</br>
[Linking the Packaging Library](#linking-the-packaging-library)</br>
[Running Commands](#running-commands)</br>
[When you are ready to commit](#When-you-are-ready-to-commit)</br>
[Useful Yarn Commands](#useful-yarn-commands)</br>

<hr>
Expand All @@ -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 <branch_name>`
1. Create a pull request (PR) using the GitHub UI [here](https://github.com/salesforcecli/plugin-packaging).

Expand Down Expand Up @@ -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/).
Comment thread
shetzel marked this conversation as resolved.
Outdated

- To increase the patch version, ensure at least 1 commit message starts with "fix:"
Comment thread
shetzel marked this conversation as resolved.
Outdated
- To increase the minor version, ensure at least 1 commit message starts with "feat:"
Comment thread
shetzel marked this conversation as resolved.
Outdated
- 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.
Comment thread
shetzel marked this conversation as resolved.
Outdated

## Useful yarn commands

#### `yarn install`
Expand Down