plugin-service-automation/CONTRIBUTING.md at main · salesforcecli/plugin-service-automation

Contributing

Please read our Code of Conduct
Please create a new issue here before starting any work so that we can also offer suggestions or let you know if there is already an effort in progress.
Sign the Salesforce CLA.
Fork this repository.
Build the plugin locally
The CLI team will review your pull request and provide feedback.
Once merged, a new release of the plugin-service-automation plugin will be published to npm.

External contributors are required to sign a Contributor License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

git clone git@github.com:salesforcecli/plugin-service-automation
cd plugin-service-automation
yarn && yarn build

Run commands locally:

./bin/dev service-process list -o YOUR_ORG

Or link the plugin and use sf:

sf plugins link .
sf service-process list -o YOUR_ORG

We work in branches off of main.
Our release (aka. production) branch is main.
Our work happens in topic branches (feature and/or bug-fix).
- Feature as well as bug-fix branches are based on main
- Branches should be kept up-to-date using rebase
- Commit messages follow Conventional commits format

Develop features and bug fixes in topic branches off main, or forks.
Topic branches can live in forks (external contributors) or within this repository (internal contributors).
- When creating topic branches in this repository please prefix with <initials>/. For example: mb/refactor-tests.
PRs will be reviewed and merged by the CLI team.

A new version of this plugin (plugin-service-automation) will be published upon merging PRs to main, with the version number increment based on commitizen rules.