Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 1.91 KB

contributing.md

File metadata and controls

68 lines (47 loc) · 1.91 KB

How to contribute

We'd love to accept your patches and contributions to this project.

Before you begin

Sign our Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

Review our community guidelines

This project follows Google's Open Source Community Guidelines.

Contribution process

Development setup

  1. Install the package with development dependencies:

    pip install -e ".[dev]"

  2. Install pre-commit hooks:

    pre-commit install

Code quality and testing

Before submitting a pull request, please ensure your changes pass linting and unit tests.

  • Linting: We use Ruff for linting and formatting. Run it with: 
    ruff check .
  • Testing: We use Pytest for unit tests. Run them with: 
    pytest

Submitting changes

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.