How to Contribute¶

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

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. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

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.

Development & Testing Workflow¶

Python Environment Setup¶

Clone the repository and navigate into it:

git clone https://github.com/twmmason/science-adk.git
cd science-adk

Set up a virtual environment with development dependencies:
```
cd python
pip install -e ".[dev,examples,mcp]"
```
Run the test suite:
```
pytest
```

Format and lint your code:

ruff check src tests
ruff format src tests

Code Style Guidelines¶

All Python code must follow the Google Python Style Guide. In particular: - Use type hints for all public function and method signatures. - Write docstrings in Google style (Args:, Returns:, Raises:). - Keep modules focused with clear __all__ exports. - Ensure all new files include the Google LLC copyright and Apache 2.0 license header.

Community Guidelines¶

This project follows Google's Open Source Community Guidelines.