imbajin commented on code in PR #313: URL: https://github.com/apache/incubator-hugegraph-ai/pull/313#discussion_r2567000420
########## .gitignore: ########## @@ -185,8 +185,6 @@ venv.bak/ # Rope project settings .ropeproject -.pre-commit-config.yaml - # mkdocs documentation Review Comment: ⚠️ **从 .gitignore 移除了 .pre-commit-config.yaml** 这是正确的做法 — `.pre-commit-config.yaml` 应该被版本控制追踪，以确保所有开发者使用相同的 hook 配置。这个修改很有必要。👍 ########## hugegraph-llm/README.md: ########## @@ -22,6 +22,16 @@ For detailed source code doc, visit our [DeepWiki](https://deepwiki.com/apache/i > - **HugeGraph Server**: 1.3+ (recommended: 1.5+) > - **UV Package Manager**: 0.7+ +### Code Quality (ruff + pre-commit) + +- Ruff is used for linting and formatting: + - `ruff format .` + - `ruff check .` +- Enable Git hooks via pre-commit: + - `pre-commit install` + - `pre-commit run --all-files` +- Config: [../.pre-commit-config.yaml](../.pre-commit-config.yaml) + ## 🚀 Quick Start Choose your preferred deployment method: Review Comment: ‼️ **潜在问题：hugegraph-llm 子目录的 README 中路径可能有问题** 配置文件位于项目根目录 `../.pre-commit-config.yaml`，但从 `hugegraph-llm/` 子目录运行 `pre-commit install` 可能不会正确识别根目录的配置。 建议： 1. 在文档中说明需要在项目根目录运行 `pre-commit install` 2. 或者验证当前配置在子目录中也能正常工作 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
