Skip to content

Commit

Permalink
chore: Adding CONTRIBUTING.md file (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
hash-data authored Dec 10, 2024
1 parent 961e6b0 commit 112280a
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Contributing to Olake

Thanks for taking the time and for your help in improving this project!

## Table of contents

- [Olake Contributing Agreement](#olake-contributor-agreement)
- [How You Can Contribute to Olake](#how-you-can-contribute-to-olake)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Committing](#committing)
- [Installing and Setting Up Olake](#installing-and-setting-up-olake)
- [Getting Help](#getting-help)

## Olake Contributor Agreement

To contribute to this project, we need you to sign the [**Contributor License Agreement (“CLA”)**][CLA] for the first commit you make. By agreeing to the [**CLA**][CLA]
we can add you to list of approved contributors and review the changes proposed by you.

## How you can contribute to Olake

You can contribute to open-source Olake project. View our [**Issues Page**](https://github.com/datazip-inc/olake/issues) to see all open issues. If you encounter a bug or have an improvement suggestion, you can [**submit an issue**](https://github.com/datazip-inc/olake/issues/new) 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 Database 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**](https://join.slack.com/t/getolake/shared_invite/zt-2usyz3i6r-8I8c9MtfcQUINQbR7vNtCQ) channel.


## Submitting a pull request

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**](https://join.slack.com/t/getolake/shared_invite/zt-2usyz3i6r-8I8c9MtfcQUINQbR7vNtCQ/) 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.

## Committing

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. Only signed commits are accepted for contribution.

## Installing and setting up Olake

To contribute to this project, you may need to install Olake on your machine. You can do so by following our [**docs**](https://datazip.io/olake/docs/olake/mongodb/how-to-start-contributing-on-olake) and set up Olake in no time.

## Getting help

For any questions, concerns, or queries, you can start by asking a question on our [**Slack**](https://join.slack.com/t/getolake/shared_invite/zt-2usyz3i6r-8I8c9MtfcQUINQbR7vNtCQ) channel.
<br><br>

### We look forward to your feedback on improving this project!


<!----variables---->

[CLA]: https://docs.google.com/forms/d/e/1FAIpQLSdze2q6gn81fmbIp2bW5cIpAXcpv7Y5OQjQyXflNvoYWiO4OQ/viewform

0 comments on commit 112280a

Please sign in to comment.