From 5c7edee833702f4febc5e135eb75718c2a0d73d6 Mon Sep 17 00:00:00 2001 From: "Sherif A. Nada" Date: Thu, 3 Jun 2021 12:42:28 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Add=20definition-of-done=20check?= =?UTF-8?q?list=20for=20connectors=20into=20PR=20template=20(#3864)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../new_python_source.md | 20 ----------- .github/pull_request_template.md | 35 +++++++++++++++---- 2 files changed, 29 insertions(+), 26 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/new_python_source.md diff --git a/.github/PULL_REQUEST_TEMPLATE/new_python_source.md b/.github/PULL_REQUEST_TEMPLATE/new_python_source.md deleted file mode 100644 index ef7f3ea32b81..000000000000 --- a/.github/PULL_REQUEST_TEMPLATE/new_python_source.md +++ /dev/null @@ -1,20 +0,0 @@ -## Contributor Checklist -Thanks for contributing to Airbyte! Please complete the following items in order so we can review your PR. -- [ ] Followed all the instructions in the locally generated checklist and your connector is functional & ready for review -- [ ] Ran the standard test suite locally via `./gradlew :airbyte-integrations:connectors:source-:standardSourceTestPython` and pasted the summarized output as a comment in this PR -- [ ] Added the connector to the [connector health page](https://docs.airbyte.io/integrations/connector-health) - -## Reviewer Pre-merge Checklist -- [ ] Finished iterating with the PR author on the code* -- [ ] Created a branch off master to merge this PR into* -- [ ] Inject the credentials in CI via `./tools/integrations/ci_credentials.sh` and `.github/workflows/test-command.yml`* -- [ ] Added the credentials for this integration to Github secrets -- [ ] Run standard tests on this branch by commenting `/test connector=`* -- [ ] Add entry in `airbyte-config/init/src/main/resources/seed/source_definitions.yaml` to use the new source in Airbyte core - - [ ] Generate UUID for `source_definitions` template here: https://www.uuidgenerator.net/ -- [ ] Deployed the connector to Dockerhub via `./tools/integrations/manage.sh publish airbyte-integrations/connectors/source-` - -## Documentation -- [ ] Add docs in `docs/integrations/sources/` folder in line with the documentation template found in `docs/contributing-to-airbyte/templates/integration-documentation-template.md`. -- [ ] Add link to create docs file to `docs/SUMMARY.md` -- [ ] Include a link to the documentation in the `README.md` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d505d443c010..3c9eed631a89 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,11 +5,34 @@ ## How *Describe the solution* +## Recommended reading order +1. `x.java` +2. `y.python` + ## Pre-merge Checklist -- [ ] *Run integration tests* -- [ ] *Publish Docker images* +Expand the checklist which is relevant for this PR. + +
Connector checklist +

+ +- [ ] Issue acceptance criteria met +- [ ] Unit & integration tests added as appropriate (and are passing) + * Community members: please provide proof of this succeeding locally e.g: screenshot or copy-paste acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run `./gradlew :airbyte-integrations:connectors::integrationTest`. +- [ ] `/test` command documented [here]() is passing. + * Community members can skip this, Airbyters will run this for you. +- [ ] Code reviews completed +- [ ] Credentials added to Github CI if needed and not already present. [instructions for injecting secrets into CI](https://docs.airbyte.io/contributing-to-airbyte/building-new-connector#using-credentials-in-ci). +- [ ] Documentation updated + - [ ] README + - [ ] CHANGELOG.md + - [ ] Reference docs in the `docs/integrations/` directory. +- [ ] Build is successful +- [ ] Connector version bumped like described [here](https://docs.airbyte.io/contributing-to-airbyte/building-new-connector#updating-a-connector) +- [ ] New Connector version released on Dockerhub by running the `/publish` command described [here](https://docs.airbyte.io/contributing-to-airbyte/building-new-connector#updating-a-connector) +- [ ] No major blockers +- [ ] PR merged into master branch +- [ ] Follow up tickets have been created +- [ ] Associated tickets have been closed & stakeholders notified +

+
-## Recommended reading order -1. `test.java` -1. `component.ts` -1. the rest