LightRAG/contributor-README.md

Handy Tips for Developers Who Want to Contribute to the Project

Pre-commit Hooks

Please ensure you have run pre-commit hooks before committing your changes.

Guides

1. Installing 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: pre-commit run --all-files

2. Pre-commit Hooks Configuration:

   • Create a .pre-commit-config.yaml file in the root of your repository.
   • Add your hooks to the .pre-commit-config.yamlfile.