Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 2.73 KB
Raw

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 INSTALLATION INSTRUCTIONS 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. 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.

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>/.
  • Before submitting a pull request, run ApexDox (Command + Shift + P > ApexDox: Run) to generate new documentation files
  • The repository comes with a pre-commit hook. If that is not executed, then the PR will fail. Please do not use GitHub Desktop to commit changes; you will need to use VSCode so that husky can execute the documentation cleanup.
  • There is a check that the documentation has been formatted properly, so to submit a pull request, you MUST install the recommended extensions, or the PR will fail.

Merging Pull Requests

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

Required Extensions

  • ApexDox is required for Pull Request approval if changing Apex code. Please install it from the recommended VSCode extensions and run ApexDox (OSX: Shift + Command + P > ApexDox: Run) before committing changes. Include the updated html files in the commit, and Husky will automatically format the documentation properly.