Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 1.37 KB

Contributing to Abso

We love your input! We want to make contributing to Abso as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Adding support for new AI providers

Development Process

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. Ensure the test suite passes
  4. Make sure your code follows the existing style
  5. Issue that pull request!

Local Development Setup

  1. Clone the repository
git clone https://github.com/yourusername/abso.git
cd abso
  1. Install dependencies
bun install
  1. Build the project
bun run build
  1. Run tests
bun test

Adding a New Provider

To add support for a new AI provider:

  1. Create a new file in src/providers/[provider-name].ts
  2. Implement the provider interface (refer to existing providers for examples)
  3. Add provider configuration in src/types.ts
  4. Add provider routing in src/utils/modelRouting.ts
  5. Create an example in examples/[provider-name].ts
  6. Update documentation to reflect the new provider

License

By contributing, you agree that your contributions will be licensed under the same license that covers the project.

Questions?

Don't hesitate to open an issue for any questions or concerns!