How to Contribute to LightRAG

[YanSte]

🚀 Handy Tips for Developers Contributing to the Project

Before you start

• If you come across an issue labeled with [Feature Request] and are interested in contributing to it, please leave a comment on the issue to confirm its objectives and proposed solution before starting to write code.
• If you have your own ideas or features to implement, first create a [Feature Request] issue, clearly outlining the background, goals, and proposed solution before beginning development. This process helps avoid duplicating work or proposing solutions that may not align with the community's expectations.
• If you simply find a bug that needs fixing, you can directly make the changes and submit a PR.

✅ 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 🙏🏻