Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1019 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 1019 Bytes

Development guide

  1. Run git fetch -- origin.

  2. Create a new branch off of the origin/main branch. For example:

    git switch --create new-branch -- origin/main

  3. Make changes, adding tests for any new code added.

  4. Ensure that pre-commit is installed and that the pre-commit Git hook is installed for the repository. For example, if Homebrew is installed:

    brew install -- pre-commit
pre-commit install

  5. Commit changes. The pre-commit Git hook will trigger and attempt to automatically flag and/or fix various issues. If some issues could not automatically be fixed, then manually fix them and commit the new changes.

  6. Push your branch. For example:

    git push --set-upstream -- origin new-branch

  7. Open a PR with the new branch as the source branch and main as the target/base branch.

  8. After the PR is approved, merge your branch into the main branch.