Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 2.35 KB

Contributing

  1. The DEVELOPING doc has details on how to set up your environment.
  2. Create a new issue here before starting your project so that we can keep track of what you are trying to add/fix. That way, 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 in your fork based on the main branch. Note, this step is recommended but technically not required if contributing using a fork.
  5. Edit the code in your fork/branch.
  6. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without associated tests.
  7. Sign CLA (see CLA below).
  8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
  9. Upon merge, a new release of the @salesforce/mcp plugin will be published to npm with a version bump corresponding to commitizen rules.

CLA

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

Branches

  • We work in branches off of main.
  • Our released (aka. production) branch is main.
  • Our work happens in topic branches (feature and/or bug-fix).

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 (committers).
    • When creating topic branches in this repository please prefix with <initials>/. For example: mb/refactor-tests.
  • PRs will be reviewed for adherence to coding standards, completeness, potential impact on the codebase, and security concerns.
  • All changes must be accompanied by appropriate tests and documentation updates.
  • If approved, admins will merge the PR.

Releasing

  • A new version of this plugin (@salesforce/mcp) will be published upon merging PRs to main, with the version number increment based on commitizen rules.