portkey-ai/CONTRIBUTING.md

Node client library for the Portkey API

## 🎉 Welcome
Hello and thank you for considering contributing to the Portkey Node 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. 
```sh
$ git clone https://github.com/YOUR_USERNAME/portkey-node-sdk.git
```
3. <TODO>

## 🖋 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:
```sh
make format; make lint
```
2. 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](https://discord.com/invite/DD7vgKK299) - 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](https://discord.com/invite/DD7vgKK299) and are mentioned in the release notes, and significant contributions are highlighted on our [Twitter](https://twitter.com/PortkeyAI). Stay tuned for more bounties and goodies for contributors in the near future!