Thanks for taking the time and for your help in improving this project!
- RudderStack Contributor Agreement
- How You Can Contribute to RudderStack
- Submitting a Pull Request
- Committing
- Installing and Setting Up RudderStack
- Getting Help
To contribute to this project, we need you to sign the Contributor License Agreement (“CLA”) for the first commit you make. By agreeing to the CLA we can add you to list of approved contributors and review the changes proposed by you.
You can contribute to any open-source RudderStack project. View our GitHub page to see all the different projects. If you encounter a bug or have an improvement suggestion, you can submit an issue describing your proposed change.
One way you can contribute to RudderStack is to create an integration. An integration is a connection between RudderStack and a downstream destination where you would like to send your event data. There are several reasons why you may want to build an integration:
- If you would like to send data to a certain destination, but RudderStack doesn't support it yet.
- If you have developed a tool that you would like RudderStack to integrate with, to expand your user base.
- If you want to add features to an already existing integration, and many more!
For more information on the different ways in which you can contribute to RudderStack, you can chat with us on our Slack channel.
Note: For creating an integration, the primary GitHub repository you will need to work with will be
rudder-transformer.
The type of change you make will dictate what repositories you will need to make pull requests for. You can reach out to us on our Slack channel if you have any questions.
For instance, to create a PR for contributing to a new third-party integration, follow these instructions on submitting an integration PR.
We prefer squash or rebase commits so that all changes from a branch are committed to master as a single commit. All pull requests are squashed when merged, but rebasing prior to merge gives you better control over the commit message.
To contribute to this project, you may need to install RudderStack on your machine. You can do so by following our docs and set up RudderStack in no time.
For any questions, concerns, or queries, you can start by asking a question on our Slack channel.