Contributing

Familiarize yourself with the codebase by reading the contributing documentation, in particular the development doc.
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.
Fork this repository.
The development doc has details on how to set up your environment.
Create a topic branch in your fork based on the correct branch (usually the main branch, see Branches section). Note: this step is recommended but technically not required if contributing using a fork.
Edit the code in your fork.
Sign CLA (see CLA).
Send us a pull request when you're done. We'll review your code, suggest any needed changes, and merge it in.

Pull Requests

We enforce commit message format. We recommend using commitizen by installing it with yarn global add commitizen and running yarn run commit-init. When you commit, we recommend that you use yarn 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.

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