Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

25 lines (22 loc) · 1.02 KB

Contributing

Thank you for considering contributing to the project! We welcome all contributions, including bug fixes, new features, and documentation improvements.

Reporting Issues

If you find a bug in the project, please report it by creating an issue on the project's GitHub page. When reporting an issue, please include the following information:

  1. A description of the issue
  2. Steps to reproduce the issue
  3. The expected behavior
  4. The actual behavior
  5. The version of the project, operating system and other relevant information

Contributing Code

To contribute code to the project, please follow these steps:

  1. Fork the project's main branch
  2. Create a new branch
  3. Make your changes
  4. Run the tests and linters (uv run poe all)
  5. Commit and push your changes to your fork
  6. Create a pull request

To get your local environment setup you can use uv sync And to check that tests and linters are working you can run uv run poe all To test the ability to install with: uv tool install --refresh --force .