Contributing

Getting started

Before you begin:

• The codebase supports python >= 3.11
• For python ./pyproject.toml for js ./frontend/package.json
• For build frontend ./frontend/webpack.config.js

Ready to make a change? Fork the repo.

Fork using GitHub Desktop:

• Getting started with GitHub Desktop will guide you through setting up Desktop.
• Once Desktop is set up, you can use it to fork the repo!

Fork using the command line:

• Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

Make your changes

The code follows the PEP-8 style guide, and generally uses the default intellij/pycharm formatting rules.

You can user all python3.11 or lower feature.

Make sure to run all the unit tests after modifying the code.

Testing

:TODO:

Open a pull request

Once you are done pushing changes to your fork, then you'll need to open a pull request (PR) to propose them for review. Inside the PR the unit tests for all supported python version will be run. Make sure your changes pass on all versions.

Once you've validated your changes feel free to let us know in a comment or edit your initial comment of the PR.