Skip to content

AGENTS.md

Latest commit

 

History

History
62 lines (49 loc) · 2.93 KB

AGENTS.md

File metadata and controls

62 lines (49 loc) · 2.93 KB
Raw

AGENTS.md

Repository-specific guidance; module files add local details.

Key relationships

Server (hugegraph-server): graph engine + REST/Gremlin API
  ├─ RocksDB: embedded backend
  └─ HStore adapter → Store client → Store: partition data + Raft

PD: placement + metadata; consulted by Server and Store
Struct: shared types/codecs; separate implementations also exist in Server
Commons: shared utilities; independent compiler and test settings

Load on demand

Work area Read when working there
Graph engine, API, backends Server
Placement, metadata, PD client PD
Distributed storage and client Store
Shared data types and serialization Struct
Utilities and RPC Commons
Container deployment Docker guide
PR requirements Contribution guide

Repository constraints

  • Use existing module boundaries; keep unrelated refactors out of a fix.
  • User-visible feature, configuration or deployment behavior changes must ship with matching docs. Update in-repository docs in the same PR; link a paired apache/hugegraph-doc PR when website docs are affected and coordinate both merges. A follow-up issue alone does not satisfy this rule. Internal-only changes can use Doc - No Need.
  • Keep README as an entry point; link detailed deployment instructions instead of duplicating them.
  • Keep AGENTS.md under 100 lines where practical. Shared rules belong here, local exceptions in module files. Keep key relationships, common commands and non-obvious pitfalls inline; reference existing sources for versions, configuration details and lengthy procedures.

Build and validation

Commands run from the repository root. Java 17 and Maven 3.6.3+; versions come from pom.xml, including ${revision}.

mvn clean install -DskipTests
mvn clean install -pl hugegraph-server -am -DskipTests

For separate distributed-module builds, install hugegraph-struct first, then build PD, Store and Server. Module guidance covers tests and CI prerequisites. Commons tests require -DskipCommonsTests=false; a successful build does not imply its tests ran.

  • Java style: 120 columns, 4 spaces, no star imports; see .editorconfig.
  • Before pushing code: mvn editorconfig:format, mvn clean compile -Dmaven.javadoc.skip=true, and relevant module tests. Documentation-only changes need link/path checks and git diff --check.
  • PD/Store .proto builds generate Java into each hg-*-grpc/src/main/java/ directory; see the corresponding gRPC module POM before editing or cleaning generated sources.
  • New dependencies require updating release LICENSE/NOTICE/licenses and dependency inventory.