From bb189b20e65471612754f60b9d443f639e8284ab Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Tue, 16 Jul 2024 13:35:22 -0400 Subject: [PATCH] Add local dev instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0c708e7..1a2decb 100644 --- a/README.md +++ b/README.md @@ -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