Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (18 loc) · 908 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (18 loc) · 908 Bytes

Contributing to TrueEye

Thank you for your interest in contributing to TrueEye! This project welcomes community involvement. Whether you're fixing a bug, improving documentation or adding new features, your contributions make a difference.

How to contribute

  1. Fork the repository and create a new branch for your change.

  2. Write clear, concise commit messages following the Conventional Commits specification.

  3. Add tests for new functionality and run the test suite using pytest.

  4. Run the linter and type checker to ensure code quality:

    ruff check src/trueeye
mypy src/trueeye

  5. Submit a pull request describing your change. Include context and motivation in the PR description.

Please be courteous and respectful in all interactions. We strive to maintain a welcoming and inclusive environment.