Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 2.45 KB
Raw

Contributing

  1. Familiarize yourself with the codebase by reading the docs, in particular the developing doc.
  2. Create a new issue before starting your project so that we can keep track of what you're 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.
  4. Set up your environment using the information in the developing doc.
  5. Create a topic branch in your fork based on the correct branch (usually the develop branch, see Branches section). Note: this step is recommended but technically not required if contributing using a fork.
  6. Edit the code in your fork.
  7. Sign the CLA (see CLA).
  8. Send us a pull request when you're done. We'll review your code, suggest any needed changes, and merge it in.

Pull Requests

Committing

We enforce commit message format. We recommend using commitizen by installing it with npm install -g commitizen and running npm run commit-init. When you commit, we recommend that you use npm run commit, which prompts you with a series of questions to format the commit message. Or you can use our VS Code Task Commit.

The commit message format that we expect is: type: commit message. Valid types are: feat, fix, improvement, docs, style, refactor, perf, test, build, ci, chore and revert.

Before commit and push, Husky runs several hooks to ensure the commit message is in the correct format and that everything lints and compiles properly.

CLA

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

Merging Pull Requests

Pull request merging is restricted to squash and merge only.

Helpful Resources

  • All of the files in the contributing folder have useful information, particularly the previously-mentioned developing doc.
  • The Source-Deploy-Retrieve Handbook contains an overview of all of the code in this project. This easy-to-read document can serve as an introduction and overview of the code and concepts, or as a reference for what a given module accomplishes and why it was designed.
  • The API documentation has details on using the classes and methods.