Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (32 loc) · 1015 Bytes

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1015 Bytes

How to contribute

Dependencies

Clone the repository. Move into the directory on your terminal.

Install dependencies for development.

uv sync

Install pre-commit to run a battery of automatic quick fixes against your work.

uv run pre-commit install

Tests

You can run unit tests to verify the library is working with the following:

uv run pytest --cov -sv

We also enforce ruff for linting, handled primarily via pre-commit. You can run it manually like so:

uv run ruff check ./datawrapper

We also enforce static typing with mypy, also handled via pre-commit. You can run it manually like so:

uv run mypy ./datawrapper --ignore-missing-imports

Before submitting

Before submitting your code please do the following steps:

  1. Add any changes you want
  2. Add tests for the new changes
  3. Run tests
  4. Run the pre-commit hooks
  5. Edit documentation if you have changed something significant

Now you're ready to submit your pull request.