Thank you for considering contributing!
We appreciate your help in making this project better.
Deploy the project by following the "Installing" section.
To maintain a consistent code style, we use ruff as code formatter and linter, and mypy for type checking.
To check your code for formatting or linting issues, run the following command:
ruff check .
This will list any issues that need to be addressed.
To auto-fix these issues, run the following command:
ruff --fix .
To ensure that your code passes type checking, run the following command:
mypy .
All log files can be found in the ./logs
directory.
When submitting a PR, please ensure that:
- Your code follows the project's coding standards.
- Your changes are well-documented.