Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.46 KB
Raw

Contributing

Most of our contributing guidelines are taken from the Zephyr project, so please refer to the Zephyr contributing guidelines for more information and help.

Development

Code style

Code formatting is automated and checked in CI using the pre-commit tool, so it behooves you to install and configure it now. Install pre-commit using pip3 install pre-commit or it might already be installed in the conda environment.

Configure pre-commit using the config in the repo:

cd "$REPO_DIR"/orb/public
pre-commit install -c utils/format/pre-commit-config.yaml --hook-type commit-msg

Check Formatting

Manually:

cd "$REPO_DIR"/orb/public && pre-commit run --all-files --config utils/format/pre-commit-config.yaml

Using Docker:

cd "$REPO_DIR"/orb/public/utils/docker
make format

Contribution workflow

New feature

Create a feature branch by prefixing with your name name/.

Commit message guidelines

gitlint is used to enforce commit message style. Commit message guidelines are directly from the Zephyr project (Zephyr guidelines).

Install gitlint using pip3 install gitlint, or it might already be installed in the conda environment.