Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (40 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 1.84 KB

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

🤝 How to submit a contribution

To make a contribution, follow the following steps:

  1. Clone this repository
  2. Create a new branch (feat, fix, test)
  3. Do the changes on your branch
  4. If you modified the code (new feature or bug-fix), please add tests for it
  5. Check the linting see below
  6. Ensure that all tests pass see below
  7. Submit a pull request

For more details about pull requests, please read GitHub's guides.

📦 Package manager

We use poetry as our package manager. You can install poetry by following the instructions here.

Please DO NOT use pip or conda to install the dependencies. Instead, use poetry:

poetry install --all-extras

📌 Pre-commit

To ensure our standards, make sure to install pre-commit before starting to contribute.

pre-commit install

🧹 Linting

We use ruff to lint our code. You can run the linter by running the following command:

ruff pandasai examples

Make sure that the linter does not report any errors or warnings before submitting a pull request.

Code Format with black

We use black to reformat the code by running the following command:

black pandasai

🧪 Testing

We use pytest to test our code. You can run the tests by running the following command:

poetry run pytest

Make sure that all tests pass before submitting a pull request.