This is an automated email from the ASF dual-hosted git repository. imbajin pushed a commit to branch update-memory in repository https://gitbox.apache.org/repos/asf/hugegraph.git
commit b01e5b95fe2092c4a0693aecef113d1437118eb3 Author: imbajin <[email protected]> AuthorDate: Mon Apr 20 21:30:33 2026 +0800 docs: improve AGENTS.md with conventions, code quality, and reference docs - Add Development Conventions section: require test coverage for all code changes - Expand Code Quality section with pre-commit checklist and .editorconfig summary - Add Reference Documents section pointing to README and .serena/memories - Link hugegraph-pd/store module names to their READMEs in root README Update .gitignore --- .gitignore | 1 + AGENTS.md | 26 +++++++++++++++++++------- README.md | 4 ++-- 3 files changed, 22 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 70911ecb4..e27322b73 100644 --- a/.gitignore +++ b/.gitignore @@ -117,3 +117,4 @@ codeium-instructions.md .ai-instructions.md *.ai-prompt.md WARP.md +.mcp.json diff --git a/AGENTS.md b/AGENTS.md index 194fc31fb..faa33094e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -45,13 +45,22 @@ mvn test -pl hugegraph-pd/hg-pd-test -am mvn test -pl hugegraph-store/hg-store-test -am ``` +## Development Conventions + +- Any code change (bug fix or feature) must have sufficient test coverage for the affected logic +- Check existing suites in `hugegraph-server/hugegraph-test` before writing new tests + ## Code Quality +Run before every commit: + ```bash -mvn editorconfig:format # Apply code style (EditorConfig) -mvn clean compile -Dmaven.javadoc.skip=true # Compile with warnings +mvn editorconfig:format # Apply code style (root .editorconfig) +mvn clean compile -Dmaven.javadoc.skip=true # Compile with warnings ``` +Key rules from `.editorconfig`: 100-char line limit, 4-space indent, LF endings, UTF-8. + ## Running the Server Scripts in `hugegraph-server/hugegraph-dist/src/assembly/static/bin/`: @@ -74,11 +83,7 @@ bin/stop-hugegraph.sh # Stop server ### Adding Third-Party Dependencies -When adding dependencies (Apache compliance): -1. Add license files to `install-dist/release-docs/licenses/` -2. Declare dependency in `install-dist/release-docs/LICENSE` -3. Append NOTICE info to `install-dist/release-docs/NOTICE` (if upstream has NOTICE) -4. Update `install-dist/scripts/dependency/known-dependencies.txt` (run `regenerate_known_dependencies.sh`) +Follow ASF compliance: update `install-dist/release-docs/` (LICENSE, NOTICE, licenses/) and `install-dist/scripts/dependency/known-dependencies.txt`. ### gRPC Protocol Changes @@ -96,3 +101,10 @@ mvn clean package -pl hugegraph-server -am -DskipTests # 4. Server ``` Key dependencies: `hugegraph-commons` is shared by all modules. `hugegraph-struct` must be built before PD and Store. Server backends depend on `hugegraph-core`. + +## Reference Documents + +| Resource | When to consult | +|----------|-----------------| +| `README.md` | Project overview, deployment topology, contribution guide | +| `.serena/memories/` | Project agent memory; key files: `suggested_commands.md` (commands), `task_completion_checklist.md` (pre-commit checks) | diff --git a/README.md b/README.md index 95e2b8b46..610c29fc9 100644 --- a/README.md +++ b/README.md @@ -110,8 +110,8 @@ HugeGraph supports both **standalone** and **distributed** deployments: | Module | Description | |--------|-------------| | [hugegraph-server](hugegraph-server) | Core graph engine with REST API, Gremlin/Cypher support, and pluggable backends (RocksDB default) | -| [hugegraph-pd](hugegraph-pd) | Placement Driver for distributed mode - handles meta storage, partition management and cluster scheduling | -| [hugegraph-store](hugegraph-store) | Distributed storage with Raft consensus for high availability and horizontal scaling | +| [hugegraph-pd](hugegraph-pd/README.md) | Placement Driver for distributed mode - handles meta storage, partition management and cluster scheduling | +| [hugegraph-store](hugegraph-store/README.md) | Distributed storage with Raft consensus for high availability and horizontal scaling | | [hugegraph-commons](hugegraph-commons) | Shared utilities, RPC framework and common components | <details>
