The open-source agent harness - the runtime layer that turns an LLM into a working agent.
Contributing
Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
Getting Started
Prerequisites
- Python 3.9+
- pip
- poetry
Installation
Install the project dependencies:
poetry install
Building
Build the project:
poetry build
Testing
Run the test suite:
poetry run pytest
Linting and Formatting
Check code style:
poetry run ruff check .
poetry run ruff format .
Type Checking
Run the type checker:
poetry run mypy .
About Generated Code
Important: Most files in this SDK are automatically generated by Fern from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
Generated Files
The following directories contain generated code:
src/- API client classes and types- Most Python files in the project
How to Customize
If you need to customize the SDK, you have two options:
Option 1: Use .fernignore
For custom code that should persist across SDK regenerations:
- Create a
.fernignorefile in the project root - Add file patterns for files you want to preserve (similar to
.gitignoresyntax) - Add your custom code to those files
Files listed in .fernignore will not be overwritten when the SDK is regenerated.
For more information, see the Fern documentation on custom code.
Option 2: Contribute to the Generator
If you want to change how code is generated for all users of this SDK:
- The Python SDK generator lives in the Fern repository
- Generator code is located at
generators/python-v2/ - Follow the Fern contributing guidelines
- Submit a pull request with your changes to the generator
This approach is best for:
- Bug fixes in generated code
- New features that would benefit all users
- Improvements to code generation patterns
Making Changes
Workflow
- Create a new branch for your changes
- Make your modifications
- Run tests to ensure nothing breaks:
poetry run pytest - Run linting and formatting:
poetry run ruff check .andpoetry run ruff format . - Run type checking:
poetry run mypy . - Build the project:
poetry build - Commit your changes with a clear commit message
- Push your branch and create a pull request
Commit Messages
Write clear, descriptive commit messages that explain what changed and why.
Code Style
This project uses automated code formatting and linting. Run poetry run ruff format . and poetry run ruff check . before committing to ensure your code meets the project's style guidelines.
Questions or Issues?
If you have questions or run into issues:
- Check the Fern documentation
- Search existing GitHub issues
- Open a new issue if your question hasn't been addressed
License
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.