Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.47 KB
Raw

Contributing to pyodi

All kinds of contributions are welcome, including but not limited to the following.

  • Fixes (typo, bugs)
  • New features and components

Workflow

  1. fork and pull the latest pyodi version
  2. checkout a new branch (do not use master branch for PRs)
  3. commit your changes
  4. create a PR

Note

  • If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.

Code style

Python

We adopt PEP8 as the preferred code style.

We use the following tools for linting and formatting:

Style configurations of black and isort can be found in pyproject.toml.

We use pre-commit hook that checks and formats for flake8, yapf, isort, fixes end-of-files, automatically on every commit. The config for a pre-commit hook is stored in .pre-commit-config.

After you clone the repository, install pyodi and development requirements with:

pip install -e .[dev]

Then, you will need to install initialize pre-commit hook:

pre-commit install

After this on every commit check code linters and formatter will be enforced.

Tests

The test suite can be run using pytest:

pytest tests/