Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

77 lines (47 loc) · 2.78 KB
Raw

🧑‍💻 Contributing to bytetrack

How to contribute

Issues, Pull Requests and Code Reviews.

Issues and Pull requests templates are mandatory.

At least one code review is needed to merge. Please merge your feature branches on develop.

We try to rebase as much as possible and use squash and merge to keep a linear and condensed git history.

Getting started

This project uses Poetry for dependency management. Poetry's doc is really good, so you should check it out if you have any questions.

To install poetry:

make download-poetry

You can start by creating a virtual environment (conda or other) or use poetry venv(please check the Makefile first if so, as poetry venv is deactivated there). Then, to install the project dependencies, run the following command:

make install

To develop, you will need dev requirements too. Run:

make install-dev-requirements

!!! note "About poetry.lock" poetry.lock is not committed deliberately, as recommended by Poetry's doc. You can read more about it here.

Codestyle

This projects uses Black, isort, ruff for codestyle. You can run the following command to format your code. It uses Pre-commit hooks to run the formatters and linters.

make format-code

Docstring convention

This project uses Google docstring convention.

A full example is available in here.

How to release

This project uses Python Semantic Versioning and Poetry to create releases and tags.

The release process is automated through GitHub Actions. Here is the process:

  • Create a Pull Request from develop to main.
  • Merge the Pull Request. This must create a merge commit.
  • The merge will trigger the Release GitHub Action defined in this workflow.

The Release GitHub Action does the following:

  • Checks out the code.
  • Runs the CI GitHub Action, which runs the tests and linters.
  • Runs Python Semantic Release, which takes care of version update, tag creation, and release creation.

The action is triggered by any push to main.

!!! tip The release action will be triggered by any push to main only if the 'CI' job in the 'release.yaml' workflow succeeds. Python Semantic Release will take care of version number update, tag creation and release creation.

When it's done, rebase develop to keep it up to date with main.

And you're done ! 🎉