Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 2.32 KB

🎉 Welcome

Hello and thank you for considering contributing to Portkey's AI Gateway! Whether you're reporting a bug, suggesting a feature, improving documentation, or writing code, your contributions are invaluable to us.

🚀 Quick Start

  1. Fork the repository on Github.
  2. Clone your forked repository to your machine.
$ git clone https://github.com/YOUR_USERNAME/gateway.git

🖋 Types of Contributions

  1. New integrations: Creating integrations for other LLM providers or vendors in general.
  2. Bug fixes
  3. Enhancements
  4. Documentation
  5. Hacktoberfest submissions!

🗓️ Hacktoberfest

During the Hacktoberfest month, running from October 1st to 31st, your accepted PR will count towards your Hacktoberfest participation! 🚀

✅ To gain acceptance, your PR must be merged, approved, or tagged with the hacktoberfest-accepted label.

🧐 Remember to adhere to the quality standards to avoid your PR being marked as spam or invalid.

🔄 Raising PRs

  1. Once you are done with your changes, format and Lint your code by running:
make format; make lint
  1. While raising your PRs, please prepend any of the following to your title:
  • provider: for adding new LLM providers.
  • integration: for new integrations.
  • docs: for new cookbooks, doc additions, etc.
  • improvement: for improvements or enhancements.
  • bug: for bug fixes.
  • hacktoberfest: for Hacktoberfest contributions

🤔 Getting Help

Facing issues or have questions? Don't hesitate to share your doubts or questions on our Discord Community - this is the quickest way to get support and connect with other contributors.

🚧 Release Process

Releases are made as soon as possible to ensure that new features and fixes reach our users quickly. We follow a seamless CI/CD pipeline to ensure the smooth transition of code from development to production.

🎊 Your PR is Merged!

All successful PRs are celebrated on our Discord and are mentioned in the release notes, and significant contributions are highlighted on our Twitter. Stay tuned for more bounties and goodies for contributors in the near future!