Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.28 KB

Contributing

Topic branch + pull request (PR)

To submit a patch, fork the repo and work within a topic branch of your fork.

  1. Bootstrap your dev environment

    script/bootstrap

  2. Set up a remote tracking branch

    git checkout -b <branch_name>

# Initial push with `-u` option sets remote tracking branch.
git push -u origin <branch_name>

  3. Ensure your branch is up-to-date:

    git fetch --prune upstream
git rebase upstream/master
git push -f

  4. Submit a Pull Request

  5. You can run tests locally via:

    script/test

Linear history

Use git rebase upstream/master to update your branch.

  • You must force-push after rebasing.
  • We never force-push to master.

The primary reason for this is to maintain a clean, linear history via "fast-forward" merges to master. A clean, linear history in master makes it easier to troubleshoot regressions and follow the timeline.