Thanks for taking the time and for your help in improving this project!
- Olake Framework Structure
- Olake Contributing Agreement
- How You Can Contribute to Olake
- Submitting a Pull Request
- Committing
- Installing and Setting Up Olake
- 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 open-source Olake project. View our Issues Page to see all open issues. 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 Olake is to create an Driver. An Driver is a connection between Olake and a Source from where you would like to fetch your event data. There are several reasons why you may want to build an Driver:
- Custom Database Support: If your organization uses a unique or proprietary database not currently supported by Olake, creating a Driver allows seamless integration and data ingestion.
- Optimized Performance: By building a custom Driver, you can tailor it to optimize for your specific use case, improving performance and reducing latency during data fetch operations
- Advanced Features: Implement additional capabilities, such as support for custom queries, change data capture, or enhanced data transformation, to better suit your data workflows.
For more information on the different ways in which you can contribute to Olake, you can chat with us on our Slack channel.
For every suggested change or issue, you can make a pull request to the appropriate branch based on the type of change. You can reach out to us on our Slack channel if you have any questions.
For example to contribute a new driver, you need to create a pull request (PR). Follow these steps to ensure your PR is well-prepared:
- Provide a clear and concise PR title.
- Write a detailed and descriptive PR description.
- Request a code review from the maintainers.
Make sure to pull the latest changes from the respective branch before committing. Run make pre-commit to validate your changes. Use a clear and descriptive commit message that reflects the purpose of your changes. Your pull request will be reviewed by the appropriate OLake maintainers.
To contribute to this project, you may need to install Olake on your machine. You can do so by following our docs and set up Olake in no time.
For any questions, concerns, or queries, you can start by asking a question on our Slack channel.