Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.23 KB
Raw

Contributing to Gate Learner

Thank you for your interest in contributing to gate_learner! We welcome contributions from everyone.

Development Setup

Ensure you have Python 3.12+ and uv installed.

  1. Clone the repository:

    git clone https://github.com/ios-community/gate-learner.git
cd gate-learner

  2. Set up the virtual environment and install dependencies:

    uv sync --all-extras

  3. Run the test suite to verify your setup:

    uv run pytest

Code Style & Quality

We enforce strict code quality standards using ruff. Before submitting a pull request, please ensure your code is formatted and free of lint errors:

# Run linter checks
uv run ruff check .

# Format code
uv run ruff format .

Documentation

All public APIs must be fully documented using the Google Style Python Docstrings format. Code examples in docstrings should be written as runnable doctests and will be validated during testing.

Submitting a Pull Request

  1. Fork the repository and create your branch from main.
  2. Ensure all tests, doctests, and linter checks pass.
  3. Commit your changes with clear, descriptive commit messages.
  4. Submit a pull request to the main branch.