Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

56 lines (42 loc) · 1.82 KB
Raw

Contributing Guidelines for RAGGENIE

🪜 Steps to Contribute

To contribute to this project, please follow these steps:

  1. Fork and clone this repository
  2. Make your changes on your fork.
  3. If you modify the code (for a new feature or bug fix), please add corresponding tests.
  4. Check for linting issues see below
  5. Ensure all tests pass see below
  6. Submit a pull request

For more detailed information about pull requests, please refer to GitHub's guides.

📦 Package manager

At the moment we are using pip as our package manager. Please make sure to include all the required libraries in requirements.txt at the time of build.

📌 Pre-commit

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

pre-commit install

🧹 Linting

We use Flake8 for linting our code. You can use the linter by running the following code.

make linting

📝 Code formatting

We use Flake8 as our code formatter. You can format the code using the following code.

make formatting

🗒 Spellcheck

We use codespell for spell checking our code. For running the spellchecker run the following code.

make spellcheck

🧪 Testing

we use pytest for integration testing the RAGGENIE. and unittest for unit testing individual components. for unit testing run the following code

make unit-test

for integration testing run the following code

make integration-test