Skip to content

Commit

Permalink
Docs: improve doc for contributing locally (#14661)
Browse files Browse the repository at this point in the history
* improve doc for contributing locally

- the format command for an individual connector is airbytePythonFormat
- provide examples for the format commands

* add `./gradlew format` for java connectors
  • Loading branch information
YiyangLi authored Jul 16, 2022
1 parent b0f559d commit 133ae07
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/contributing-to-airbyte/developing-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,16 @@ If you are working in the platform run `SUB_BUILD=PLATFORM ./gradlew format` fro

### Connector

If you are working on an individual connectors run: `./gradlew :airbyte-integrations:<directory the connector is in e.g. source-postgres>:format`.
To format an individual connector in python, run:
```
./gradlew :airbyte-integrations:connectors:<connector_name>:airbytePythonFormat
```
For instance:
```
./gradlew :airbyte-integrations:connectors:source-s3:airbytePythonFormat
```

To format connectors in java, run `./gradlew format`

### Connector Infrastructure

Expand Down

0 comments on commit 133ae07

Please # to comment.