From d5a7ffb0f0ac609f2d1f658069a120fb2e7ecfa4 Mon Sep 17 00:00:00 2001 From: Ashpreet Bedi Date: Wed, 10 Jan 2024 11:10:06 +0000 Subject: [PATCH] CONTRIBUTING --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3317bd004..c6f8c3cdf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,35 @@ As an open-source project we welcome contributions. ## 👩‍💻 How to contribute -Please follow the [fork and pull request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow. +Please follow the [fork and pull request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow: - Fork the repository. - Create a new branch for your feature. - Add your feature or improvement. - Send a pull request. - We appreciate your support & input! + +## Development setup + +1. Clone the repository. +2. Create a virtual environment using the `./scripts/create_venv.sh` script. This will: + - Create a `phienv` virtual environment in the current directory. + - Install the required packages. + - Install the `phidata` package in editable mode. +3. Activate the virtual environment using `source phienv/bin/activate`. + +## Formatting and validation + +We provide a `./scripts/format.sh` script that runs `ruff`, `mypy` and `pytest`. + +Please run this script before submitting a pull request. + +## 📝 License + +This project is licensed under the terms of the [MIT license](/LICENSE) + +## 📚 Resources + +- Documentation +- Discord +- Email: help@phidata.com