Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.12 KB
Raw

Contributing

Before you start

Contributions are welcome, but be sure to read the guidelines below first.

  • Non-trivial changes should be discussed in an issue first. This is to avoid wasted effort if the change isn't a good fit for the project.

  • Before picking up an issue, please comment on it to let others know you're working on it. This will help avoid duplicated effort.

  • Some tests are skipped on Windows. These tests use unix-specific features to set the timezone for the current process. As a result, Windows isn't able to run certain tests that rely on the system timezone. It appears that this functionality (only needed for the tests) is not available on Windows.

Setting up a development environment

An example of setting up things up on a Unix-like system:

# install the dependencies
make init

# build the rust extension
make build

make test  # run the tests (Python and Rust)
make format  # apply autoformatting
make ci-lint  # various static checks
make typecheck  # run mypy and typing tests