3.1 KiB
3.1 KiB
👋 Welcome to Airbyte!
Thank you for your contribution from {{ .repo_name }}! We're excited to have you in the Airbyte community.
Helpful Resources
- PR Guidelines: Check our guidelines for contributions.
- Breaking Changes Guide: Guide to breaking changes, migration guides, and upgrade deadlines.
- Developing Connectors Locally: Learn how to set up your environment and develop connectors locally.
- If you enable BYO Connector Credentials within your fork, you can view your test results [here](https://github.com/{{ .repo_name }}/actions/workflows/run-connector-tests-command.yml): [](https://github.com/{{ .repo_name }}/actions/workflows/run-connector-tests-command.yml)
PR Slash Commands
As needed or by request, Airbyte Maintainers can execute the following slash commands on your PR:
/format-fix- Fixes most formatting issues./bump-version- Bumps connector versions./run-connector-tests- Runs connector tests./run-cat-tests- Runs CAT tests./run-live-tests- Runs live tests for the modified connector(s)./run-regression-tests- Runs regression tests for the modified connector(s)./build-connector-images- Builds and publishes a pre-release docker image for the modified connector(s)./publish-connectors-prerelease- Publishes pre-release connector builds (tagged as{version}-preview.{git-sha}) for all modified connectors in the PR.
If you have any questions, feel free to ask in the PR comments or join our Slack community.
Tips for Working with CI
- Pre-Release Checks. Please pay attention to these, as they contain standard checks on the metadata.yaml file, docs requirements, etc. If you need help resolving a pre-release check, please ask a maintainer.
- Note: If you are creating a new connector, please be sure to replace the default
logo.svgfile with a suitable icon.
- Note: If you are creating a new connector, please be sure to replace the default
- Connector CI Tests. Some failures here may be expected if your tests require credentials. Please review these results to ensure (1) unit tests are passing, if applicable, and (2) integration tests pass to the degree possible and expected.
- (Optional.) BYO Connector Credentials for tests in your fork. You can optionally set up your fork with BYO credentials for your connector. This can significantly speed up your review, ensuring your changes are fully tested before the maintainers begin their review.