Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 921 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 921 Bytes

Contributing

Thank you for considering contributing!
We appreciate your help in making this project better.

Installing

Deploy the project by following the "Installing" section.

Code Formatting and Linting

To maintain a consistent code style, we use ruff as code formatter and linter, and mypy for type checking.

ruff

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 .

mypy

To ensure that your code passes type checking, run the following command:

mypy .

Logs

All log files can be found in the ./logs directory.

Pull Requests

When submitting a PR, please ensure that:

  1. Your code follows the project's coding standards.
  2. Your changes are well-documented.