Skip to content

Commit

Permalink
Add local dev instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lpsinger committed Jul 16, 2024
1 parent 6f4c18a commit bb189b2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,19 @@ The following is the minimum AWS IAM policy to grant the necessary permissions t
```

[Confluent Platform docker containers]: https://docs.confluent.io/platform/current/installation/docker/config-reference.html

## How to contribute

This package uses [Poetry](https://python-poetry.org) for packaging and Python virtual environment management. To get started:

1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and [clone](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository) this repository.

2. Install Poetry by following [their installation instructions](https://python-poetry.org/docs/#installation).

3. Install this package and its dependencies by running the following command inside your clone of this repository:

poetry install --all-extras

4. Run the following command to launch a shell that is preconfigured with the project's virtual environment:

poetry shell

0 comments on commit bb189b2

Please sign in to comment.