Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 1.76 KB

Contributing

  1. Please read our Code of Conduct.
  2. 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.
  3. Fork this repository (external contributors) or branch off main (committers).
  4. Create a topic branch based on main. This is recommended but not required if contributing using a fork.
  5. Edit the code in your fork/branch.
  6. Sign the Salesforce CLA.
  7. The CLI team will review your pull request and provide feedback.
  8. Once merged, a new release of @salesforce/cli will be published to npm.

CLA

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

Branches

  • 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

Pull Requests

  • 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.
  • Use conventional commits to drive semver versioning. Examples:
    • chore: my chore message --> No release
    • fix: my fix message --> Patch release
    • feat: my feat message --> Minor release
  • PRs will be reviewed and merged by the CLI team.