Contributing to Airbyte
Thank you for your interest in contributing! We love community contributions. Contribution guidelines are listed below. If you're unsure about how to start contributing or have any questions even after reading them, feel free to ask us on Slack in the #dev or #general channel.
However, for those who want a bit more guidance on the best way to contribute to Airbyte, read on. This document will cover what we're looking for. By addressing the points below, the chances that we can quickly merge or address your contributions will increase.
Code of conduct
Please follow our Code of conduct in the context of any contributions made to Airbyte.
Before you can start contributing, you need to understand Airbyte's data protocol specification.
First-time contributors, welcome!
We appreciate first time contributors and we are happy to assist you in getting started. In case of questions, just reach out to us via email or Slack!
Here is a list of easy good first issues to do.
Areas for contributing
We gladly welcome all improvements existing on the codebase.
1. Open an issue, or find a similar one.
Before jumping into the code please first:
- Verify if an existing GitHub issue matches your contribution project (please filter with the area/connectors or area/platform labels).
- If you don't find an existing issue, please create a new one to explain what you want to achieve.
- Assign the issue to yourself and add a comment to tell that you want to work on this.
This will enable our team to make sure your contribution does not overlap with existing works and will comply with the design orientation we are currently heading the product toward. If you do not receive an update on the issue from our team, please ping us on Slack!
2. Let's code
- Fork our GitHub repository.
- Open a branch for your work.
- Code, and please write tests.
- Ensure all tests pass. For connectors, this includes acceptance tests as well.
3. Open a pull request
- Rebase master with your branch before submitting a pull request.
- Open the pull request.
- Wait for a review from a community maintainer or our team.
4. Review process
When we review, we look at:
- Does the PR solve the issue?
- Is the proposed solution reasonable?
- Is it tested? (unit tests or integration tests)
- Is it introducing security risks? Once your PR passes, we will merge it 🎉.
It's easy to add your own connector to Airbyte! Since Airbyte connectors are encapsulated within Docker containers, you can use any language you like. Here are some links on how to add sources and destinations. We haven't built the documentation for all languages yet, so don't hesitate to reach out to us if you'd like help developing connectors in other languages.
For sources, simply head over to our Python CDK.
The CDK currently does not support creating destinations, but it will very soon.
- See Building new connectors to get started.
- Since we frequently build connectors in Python, on top of Singer or in Java, we've created generator libraries to get you started quickly: Build Python Source Connectors and Build Java Destination Connectors
- Integration tests (tests that run a connector's image against an external resource) can be run one of three ways, as detailed here
Please note that, at no point in time, we will ask you to maintain your connector. The goal is that the Airbyte team and the community helps maintain the connector.
Our goal is to keep our docs comprehensive and updated. If you would like to help us in doing so, we are grateful for any kind of contribution:
- Report missing content
- Fix errors in existing docs
- Help us in adding to the docs
The contributing guide for docs can be found here.
We welcome contributions as new tutorials / showcases / articles, or to any of the existing guides on our tutorials page:
- Fix errors in existing tutorials
- Add new tutorials (please reach out to us if you have ideas to avoid duplicate work)
- Request tutorials
We have a repo dedicated to community content. Everything is documented there.
Feel free to submit a pull request in this repo, if you have something to add even if it's not related to anything mentioned above.
Other ways you can contribute
Upvoting issues, feature and connector requests
You are welcome to add your own reactions to the existing issues. We will take them in consideration in our prioritization efforts, especially for connectors.
❤️ means that this task is CRITICAL to you.
👍 means it is important to you.
Requesting new features
To request new features, please create an issue on this project.
If you would like to suggest a new feature, we ask that you please use our issue template. It contains a few essential questions that help us understand the problem you are looking to solve and how you think your recommendation will address it. We also tag incoming issues from this template with the "community_new" label. This lets our teams quickly see what has been raised and better address the community recommendations.
To see what has already been proposed by the community, you can look here.
Watch out for duplicates! If you are creating a new issue, please check existing open, or recently closed. Having a single voted for issue is far easier for us to prioritize
Requesting new connectors
This is very similar to requesting new features. The template will change a bit and all connector requests will be tagged with the “community” and “area/connectors” labels.
To see what has already been proposed by the community, you can look here. Again, watch out for duplicates!
Bug reports help us make Airbyte better for everyone. We provide a preconfigured template for bugs to make it very clear what information we need.
Please search within our already reported bugs before raising a new one to make sure you're not raising a duplicate.
Reporting security issues
Please do not create a public GitHub issue. If you've found a security issue, please email us directly at email@example.com instead of raising an issue.