How to Contribute to LightRAG

[YanSte]

🚀 Handy Tips for Developers Contributing to the Project

✅ Setup

Before committing your changes, please ensure to follow this steps.

📖 Setup Guide

1️⃣ Install the Project

• Clone the LightRAG repository: git clone <repository_url>
• Navigate to the root directory of the project: cd LightRAG
• Install dependencies: pip install . -e

2️⃣ Install and Run Pre-commit Hooks

• Install pre-commit using pip: pip install pre-commit
• Initialize pre-commit in your repository: pre-commit install
• Run pre-commit hooks manually: pre-commit run --all-files

3️⃣ Before Creating a Pull Request

To ensure all CI validations pass before opening a pull request, run: pre-commit run --all-files

Fix any reported issues, and you’re good to go! 🚀

Thanks 🙏🏻