Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 2.1 KB
Raw

BEFORE YOU CONTRIBUTE:

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.

Contributing

  1. 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.
  2. Fork this repository.
  3. The README has details on how to set up your environment.
  4. Create a topic branch in your fork based on the correct branch (the master branch, see Branches section below). Note, this step is recommended but technically not required if contributing using a fork.
  5. Edit the code in your fork.
  6. Sign CLA (see CLA below)
  7. 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

  • Our released (aka. production) branch is master.
  • Our work happens in topic branches (feature and/or bug-fix).
    • feature as well as bug-fix branches are based on master
    • 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.

    • They are usually only ok when done by our release automation.

  • Topic branches are:

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

  • Hot-fix branches are an exception.

    • Instead we aim for faster cycles and a generally stable master branch.

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>/.

Merging Pull Requests

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