Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (42 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

72 lines (42 loc) · 1.24 KB

Contributing to go-openrouter 🤖

Welcome! We appreciate your interest in improving this unofficial Go client for OpenRouter.

Getting Started 🚀

  1. Install Go (1.20+ recommended)
  2. Fork the repository
  3. Clone your fork: 
    git clone https://github.com/your-username/go-openrouter.git

Contribution Guidelines 📝

Before You Code

Check existing issues/pull requests

Open an issue first for significant changes

Development Flow

Create a feature branch:

bash Copy git checkout -b feat/your-feature-name Follow Go conventions:

Use gofmt

Include tests for new features

Add documentation for public symbols

Write clear commit messages using Conventional Commits

Testing ✅

Run tests:

bash Copy go test -v ./... Include integration tests for API calls (use test credentials)

Submitting Changes 📬

Push your branch

Create a Pull Request against main

Include:

Description of changes

Related issues

Test results

Any caveats

Code of Conduct 🏛️

Be excellent to each other! Follow the Contributor Covenant.

Acknowledgements 🙌

All contributors will be recognized in our CREDITS.md file.

This is an unofficial project not affiliated with OpenRouter. Let's build something great together! 🚀