Contributing to the TypeScript SDK
This guide will help you get started with contributing to the Opik TypeScript SDK.
Before you start, please review our general Contribution Overview and the Contributor License Agreement (CLA).
Project Structure
The TypeScript SDK is located in the sdks/typescript
directory. Here’s an overview of the key files and directories:
src/
: Contains the main source codetests/
: Contains test filesexamples/
: Contains example usage of the SDKpackage.json
: Project dependencies and scriptstsconfig.json
: TypeScript configurationtsup.config.ts
: Build configurationvitest.config.ts
: Test configuration
Setup
Development Workflow
Testing
We use Vitest for testing. Tests are located in the tests/
directory. When adding new features:
Building
The SDK is built using tsup. To build:
This will create the distribution files in the dist/
directory.
Documentation
When adding new features or making changes:
Code Style
We use ESLint for code style enforcement. The configuration is in eslint.config.js
. Before submitting a PR:
Pull Request Process
Your PR should:
- Have a clear description of the changes
- Include tests for new functionality
- Pass all CI checks
- Follow the project’s coding standards
Need Help?
If you need help or have questions:
- Open an issue on GitHub
- Join our Comet Chat community
- Check the existing documentation
Remember to review our Contributor License Agreement (CLA) before contributing.