Contributing to Beluga AI
Thank you for your interest in contributing to Beluga AI! Beluga is a large framework — 157 packages and 100+ providers — built by a community that values code quality, consistent patterns, and thorough testing. Every contribution helps make the framework better for Go developers building production AI systems. Whether you’re fixing a typo, reporting a bug, or implementing a new feature, your help is valued and appreciated.
Ways to Contribute
Section titled “Ways to Contribute”There are many ways to contribute to Beluga AI, and not all of them involve writing code. The framework benefits as much from clear documentation, well-reported bugs, and community support as it does from code changes:
- Bug Reports — Found something that doesn’t work? Open an issue with a clear description and reproduction steps.
- Feature Requests — Have an idea for a new feature or improvement? Start a discussion or open an issue to share your thoughts.
- Documentation Improvements — Spotted a typo, unclear explanation, or missing guide? Documentation PRs are always welcome.
- Code Contributions — Fix bugs, implement features, add providers, or improve performance. See the Development Setup to get started.
- Answering Questions — Help other users in GitHub Discussions by sharing your experience and knowledge.
Communication Channels
Section titled “Communication Channels”- GitHub Issues — Bug reports, feature requests, and task tracking.
- GitHub Discussions — Questions, ideas, design proposals, and general conversation.
Code of Conduct
Section titled “Code of Conduct”All contributors are expected to follow our Code of Conduct. Please read it before participating. We are committed to providing a welcoming and inclusive experience for everyone.
Quick Links
Section titled “Quick Links”| Topic | Description |
|---|---|
| Development Setup | Set up your local environment |
| Code Style | Coding conventions and style guidelines |
| Testing | How to write and run tests |
| Pull Requests | Submitting changes for review |
| Releases | How releases are managed |
First-Time Contributors
Section titled “First-Time Contributors”New to Beluga AI or open-source in general? Welcome! The codebase follows consistent patterns across all packages, so once you understand how one package works, that knowledge transfers to all 19 registries. Here’s how to get started:
- Look for issues labeled
good-first-issue— these are specifically curated for newcomers and include extra context to help you get oriented. - Read the Development Setup guide to configure your environment.
- Review the Code Style guide to understand our conventions.
- Pick an issue, leave a comment saying you’d like to work on it, and start coding!
Don’t hesitate to ask questions on the issue or in Discussions if you get stuck. We’re happy to help.