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
- Node.js 20 or higher
- pnpm package manager
Installation
Install the project dependencies:
pnpm install
Building
Build the project:
pnpm build
Testing
Run the test suite:
pnpm test
Run specific test types:
pnpm test:unit- Run unit testspnpm test:wire- Run wire/integration tests
Linting and Formatting
Check code style:
pnpm run lint
pnpm run format:check
Fix code style issues:
pnpm run lint:fix
pnpm run format:fix
Or use the combined check command:
pnpm run check:fix
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/- API client classes and typessrc/serialization/- Serialization/deserialization logic- Most TypeScript files in
src/
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 TypeScript SDK generator lives in the Fern repository
- Generator code is located at
generators/typescript/sdk/ - 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:
pnpm test - Run linting and formatting:
pnpm run check:fix - Build the project:
pnpm 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 pnpm run check:fix 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.