Skip to content

Latest commit

 

History

History
99 lines (66 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

99 lines (66 loc) · 2.57 KB
Raw

Contributing

If you want to extend our Python library or if you find a bug, please open a PR!

Also be sure to test your code with the unittest command at the /root level directory.

Installation for Contributors

Before starting your work on the project, set up your development environment:

  1. Clone the repository:
git clone https://github.com/roboflow-ai/roboflow-python.git
cd roboflow-python
  1. Create and activate a virtual environment:
python3 -m venv env
source env/bin/activate

3.Install the package in editable mode with development dependencies:

pip install -e ".[dev]"

Devcontainer

This project comes with a convenient devcontainer that makes it easier to run tests and has lint configured to run on save.

On rare occasions a full rebuild is needed, you can do it in VSCode by pressing Ctrl+Shift+P and running Dev Containers: Rebuild Container.

Tests

python -m unittest

When creating new functions, please follow the Google style for Python docstrings. See example below:

def example_function(param1: int, param2: str) -> bool:
    """Example function that does something.

    Args:
        param1: The first parameter.
        param2: The second parameter.

    Returns:
        The return value. True for success, False otherwise.

    """

We provide a Makefile to format and ensure code quality. Be sure to run them before creating a PR.

# format code with `ruff`
make style

# check code with `ruff`
make check_code_quality

Note These tests will be run automatically when you commit thanks to git hooks.

Docs

The docs can be built with mkdocs serve.

Before that, install the dependencies:

python -m pip install mkdocs mkdocs-material mkdocstrings mkdocstrings[python]

Pre-commit Hooks

To ensure code quality and consistency, we use pre-commit hooks. Follow these steps to set up pre-commit in your development environment:

  1. Install pre-commit:
pip install pre-commit
  1. Install the git hook scripts:
pre-commit install

After installation, pre-commit will automatically run on git commit. The hooks perform checks and corrections related to code formatting, linting, and other rules as defined in the .pre-commit-config.yaml file.

Note: If you need to bypass pre-commit hooks temporarily, you can use the --no-verify flag:

git commit --no-verify -m "Your commit message"