Skip to content

Latest commit

 

History

History
43 lines (37 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

43 lines (37 loc) · 1.87 KB
Raw

🎉 Welcome

Hello and thank you for considering contributing to the Portkey Python SDK! 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/portkey-python-sdk.git
  1. Set up a virtual environment.
$ cd portkey-python-sdk
$ python -m venv .venv
$ source .venv/bin/activate # On macOS and Linux
  1. Install dependencies
$ pip install -r requirements.txt.

🖋 Types of Contributions

  1. New integrations: Creating integrations for other LLM providers or vendors in general.
  2. Bug fixes
  3. SDK enhancements

🔄 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:
  • integration: for new integrations.
  • improvement: for improvements or enhancements.
  • bug: for bug fixes.

🤔 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!