Skip to content

AGENTS.md

Latest commit

 

History

History
62 lines (47 loc) · 2.74 KB

AGENTS.md

File metadata and controls

62 lines (47 loc) · 2.74 KB

AGENTS.md - StarRocks

Agent entrypoint for this repository. Start with the nearest nested AGENTS.md; use this file for repo-wide rules only.

Read Order

  1. Read handbook/index.md for repo topology, architecture entrypoints, and active engineering plans. If handbook/plans/local/index.md exists, treat it as a checkout-local extension to the tracked plan set after reading handbook/plans/index.md.
  2. Read the nearest nested AGENTS.md.
  3. For Backend work, read handbook/domains/backend.md and be/AGENTS.md.
  4. For Frontend work, read handbook/domains/frontend.md and fe/AGENTS.md.
  5. For SQL tests, docs, generated code, Java extensions, or CI/tooling, read the matching handbook/domains/ page before the nested guide.

Repo Map

  • be/: C++ backend for execution, storage, services, and data processing.
  • fe/: Java frontend for parsing, planning, metadata, and coordination.
  • gensrc/: generated thrift/protobuf code.
  • test/: SQL integration tests.
  • docs/: user and admin documentation.
  • java-extensions/: JNI and external source integrations.

Quick Commands

# Build backend or frontend
./build.sh --be
./build.sh --fe

# Run backend or frontend unit tests
./run-be-ut.sh
./run-fe-ut.sh

# Run SQL integration tests
cd test && python3 run.py -v

Repo-Wide Invariants

  • Do not hand-edit generated outputs in gensrc/ unless the generator workflow explicitly requires it.
  • Protobuf fields must stay optional/repeated; never add required and never reuse ordinals.
  • Thrift fields must stay optional/repeated; never add required and never reuse ordinals.
  • User-facing config or metric changes must update the matching docs in docs/en/ and docs/zh/ when applicable.

PR Contract

  • Commit messages: English, imperative, concise.
  • PR titles: [BugFix] ..., [Feature] ..., [Enhancement] ..., [Refactor] ..., [UT] ..., [Doc] ..., or [Tool] ....
  • Fill the repository PR template completely, including behavior-change classification and test/docs checkboxes.
  • Bug-fix PRs intended for branch backports must set the version checkboxes that drive auto-backporting.

Nested Guides