Skip to content

Commit 51dad94

Browse files
authored
Update CONTRIBUTING.md
1 parent fffea7a commit 51dad94

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

docs/CONTRIBUTING.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,7 @@ Thank you for being interested in contributing to Airbyte Python CDK! Here are s
1313

1414
Here are some tips to get started using the project dependencies and development tools:
1515

16-
1. Clone the CDK repo. If you will be testing connectors, you should clone the CDK into the same parent directory as `airbytehq/airbyte`, which contains the connector definitions.
1716
1. Make sure your Python version is 3.11
18-
1. Make sure [Poetry is installed](https://python-poetry.org/docs/#) (version 2.0 or higher).
19-
1. Run `poetry install --all-extras`.
20-
1. Unit tests can be run via `poetry run pytest`.
21-
22-
Note: By default in Poetry 2.0, `poetry lock` only refreshes the lockfile without pulling new versions. This is the same behavior as the previous `poetry lock --no-update` command.
23-
1. You can use "Poe" tasks to perform common actions such as lint checks (`poetry run poe lint`), autoformatting (`poetry run poe format-fix`), etc. For a list of tasks you can run, try `poetry run poe list`.
24-
2517

2618
Fedora 41:
2719

@@ -37,7 +29,7 @@ Fedora 41:
3729
sudo dnf install pip
3830
```
3931

40-
3. [Install Poetry](https://python-poetry.org/docs/#):
32+
3. [Install Poetry](https://python-poetry.org/docs/#) 2.0 or higher:
4133

4234
```bash
4335
pip install poetry
@@ -53,6 +45,7 @@ Fedora 41:
5345
```bash
5446
sudo dnf install poetry
5547
```
48+
Note: You can use "Poe" tasks to perform common actions such as lint checks (`poetry run poe lint`), autoformatting (`poetry run poe format-fix`), etc. For a list of tasks you can run, try `poetry run poe list`. See [Poe the Poet](https://poethepoet.natn.io/)
5649

5750
4 Use the Python 3.11 environment:
5851

@@ -69,13 +62,15 @@ poetry env info
6962
# validate 3.11 referred
7063
```
7164

72-
5 In the **airbyte-python-cdk project** install [Poe the Poet](https://poethepoet.natn.io/) and unit tests' prerequisites:
65+
5. Clone the CDK repo. If you will be testing connectors, you should clone the CDK into the same parent directory as `airbytehq/airbyte`, which contains the connector definitions.
66+
6. In the **airbyte-python-cdk project** install the unit tests' prerequisites:
7367

7468
```bash
7569
poetry install --all-extras
7670
```
71+
Note: By default in Poetry 2.0, `poetry lock` only refreshes the lockfile without pulling new versions. This is the same behavior as the previous `poetry lock --no-update` command.
7772

78-
6 If your operating system is RHEL or compatible, execute:
73+
7 If your operating system is RHEL or compatible, execute:
7974

8075
```bash
8176
# just for the current session, until restart
@@ -90,12 +85,12 @@ See also:
9085
- [Dager-Podman Integration](https://blog.playgroundtech.io/introduction-to-dagger-6ab55ee28723)
9186
- [CDK Issue 197](https://github.com/airbytehq/airbyte-python-cdk/issues/197)
9287

93-
7. Make sure Docker is installed locally, instead of Podman
88+
8. Make sure Docker is installed locally, instead of Podman
9489
See also:
9590

9691
- [CDK Issue 197](https://github.com/airbytehq/airbyte-python-cdk/issues/197)
9792

98-
8. Edit airbyte/airbyte-integrations/connectors/source-shopify/acceptance-test-config.yml and change:
93+
9. Edit airbyte/airbyte-integrations/connectors/source-shopify/acceptance-test-config.yml and change:
9994

10095
```
10196
connector_image: airbyte/source-shopify:dev to connector_image: airbyte/source-shopify:<version>
@@ -280,8 +275,6 @@ The Airbyte CDK defines common development tasks using [Poe the Poet](https://po
280275
Optionally, if you can [pre-install Poe](https://poethepoet.natn.io/installation.html) with `pipx install poethepoet` and then you will be able to run Poe tasks with the shorter `poe TASKNAME` syntax instead of `poetry run poe TASKNAME`.
281276
The Ruff configuration is stored in `ruff.toml` at the root of the repository. This file contains settings for line length, target Python version, and linting rules.
282277

283-
The Ruff configuration is stored in `ruff.toml` at the root of the repository. This file contains settings for line length, target Python version, and linting rules.
284-
285278
## Auto-Generating the Declarative Schema File
286279

287280
Low-code CDK models are generated from `sources/declarative/declarative_component_schema.yaml`. If the iteration you are working on includes changes to the models or the connector generator, you may need to regenerate them. To do that, you can run:

0 commit comments

Comments
 (0)