Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Latest commit

 

History

History
48 lines (32 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.04 KB

How to Contribute

See instruction for specifications.

Getting Started

It is recommended to use asdf to manage the versions of the used languages, including Python and Node.js. See .tool-versions for the versions used in this project.

Install Python 3.10 or later.

Install Poetry 1.3.2 or later. See Poetry's documentation for details.

Install the project's dependencies:

poetry install --no-root

Since the pre-commit hooks require Node.js, you need to install it. See documentation for details.

Install pre-commit hooks:

poetry run pre-commit install

Activate the virtual environment:

poetry shell

Running Tests

poetry run pytest

Notes

If you found Could not load the qt platform plugin "xcb" in "" even though it error, see this for details.