Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 2.57 KB

Contributing

  1. Familiarize yourself with the codebase.
  2. Create a new issue 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. We will let you know when you're good to go to start.
  3. Fork this repository.
  4. The README has details on how to set up your environment.
  5. Create a topic branch in your fork based on the correct branch (usually the main branch. Note, this step is recommended but technically not required if contributing using a fork.
  6. Edit the code in your fork.
  7. If using an AI coding assistant (Cursor, Copilot, Claude, etc.), configure it to use the rule files in the .airules/ directory:
    • RECIPE-STYLE-GUIDE.md -- Core recipe coding philosophy (inline queries, explicit types, no utility imports)
    • README_STRUCTURE.md -- Markdown formatting and structure rules
    • GENERATE_CHANGELOG.md -- Changelog generation guidelines
  8. Sign CLA (see CLA below)
  9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

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 main.
  • Our released (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
    • see below for further merge instructions

Merging between branches

  • We try to limit merge commits as much as possible.

  • Topic branches are:

    1. based on main and will be
    2. squash-merged into main.

Pull Requests

  • Develop features and bug fixes in topic branches.
  • Topic branches can live in forks (external contributors) or within this repository (committers). ** When creating topic branches in this repository please prefix with <developer-name>/.

Prerelease Branches

Branches prefixed with prerelease/ receive special CI treatment: the scratch org job creates a preview scratch org (using --release=preview) so changes can be validated against the upcoming Salesforce release. This mirrors the pattern used in lwc-recipes. You can also trigger a prerelease CI run manually via the workflow_dispatch input on the CI on PR workflow.

Merging Pull Requests

  • Pull request merging is restricted to squash & merge only.