Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (50 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 1.91 KB

Contributing to Hyperion Gateway

Thank you for your interest in contributing to Hyperion! We welcome contributions from the community to help make this the best AI gateway available.

Code of Conduct

By participating in this project, you agree to abide by the Contributor Covenant Code of Conduct.

How Can I Contribute?

Reporting Bugs

  • Check the Issues to see if the bug has already been reported.
  • If not, open a new issue with a clear title, description, and steps to reproduce.
  • Include relevant environment details (OS, Docker version, Gateway config).

Suggesting Enhancements

  • Open an issue to discuss the enhancement before starting implementation.
  • Explain why the feature would be useful and how it should work.

Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or fix (git checkout -b feature/my-new-feature).
  3. Ensure your code follows the Coding Standards.
  4. Write tests for your changes.
  5. Submit a Pull Request against the main branch.

Development Setup

Prerequisites

  • Go 1.22+
  • Docker & Docker Compose
  • Python 3.10+ (for microservices)
  • Node.js 18+ (for dashboard)

Building Locally

# Gateway
cd gateway
go build ./cmd/server/main.go

# Dashboard
cd dashboard
npm install
npm run build

Running Tests

cd gateway
go test ./...

Coding Standards

Go

Python

  • Use black for formatting.
  • Use type hints where possible.
  • Follow PEP 8 guidelines.

License

By contributing, you agree that your contributions will be licensed under the project's AGPL-3.0 License.