Skip to content

Commit

Permalink
CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
ashpreetbedi committed Jan 10, 2024
1 parent 3844672 commit d5a7ffb
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

- <a href="https://docs.phidata.com/introduction" target="_blank" rel="noopener noreferrer">Documentation</a>
- <a href="https://discord.gg/4MtYHHrgA8" target="_blank" rel="noopener noreferrer">Discord</a>
- Email: <a href="mailto:help@phidata.com" target="_blank" rel="noopener noreferrer">help@phidata.com</a>

0 comments on commit d5a7ffb

Please sign in to comment.