Contributing to Hebrew

This project welcomes contributions in the form of Pull Requests. For clear bug-fixes / typos etc. just submit a PR. For new features or if there is any doubt in how to fix a bug, you might want to open an issue prior to starting work.

Development Environment

Hebrew uses poetry for packaging and dependency management. To start developing with Hebrew, install Poetry using the recommended method or run:

pip install poetry

Once Poetry is installed, install the dependencies with the following command:

poetry install --with=dev

Tests

Run tests with the following command:

poetry run pytest --codeblocks

The --codeblocks flag runs tests on the python code blocks found in markdown files and is critical to testing!

New code should ideally have tests and not break existing tests.

If you are not familiar with writing tests but still want to contribute to this package, please feel free to submit your pull request, and I will work on tests. 🙂

Type Checking

Please add type annotations for all new code.

Code Formatting

This repo uses black for code formatting. I recommend setting up black in your editor to format on save.

To run black from the command line:

black <path-to-files-changed>