mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-09-12 16:32:16 +00:00
dennis zhuang
5d4699db1c
* docs: refine coding agent maps Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: trim license header guidance Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: update README links and project status Signed-off-by: Dennis Zhuang <killme2008@gmail.com> --------- Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
2.2 KiB
2.2 KiB
Agent Resources
Shared resources for coding agents (Codex, Claude Code, ...) and contributors.
Skills
Shared agent skills live in .agents/skills.
- Codex automatically discovers repo skills from
.agents/skills. - Claude Code reads the same skills through
.claude/skills, which is a symlink to this directory. - Add or update shared skills under
.agents/skills/<skill-name>/SKILL.md. - If a new skill does not appear, restart the agent or start a new thread.
Per-directory guides
Read every AGENTS.md from the repository root down to the path being changed.
The root guide applies everywhere; nested guides add rules and navigation for
their subtree.
src/common/meta/AGENTS.md— metadata keys, KV backends, DDL procedures, and cachessrc/query/AGENTS.md— query planning, optimization, and distributed executionsrc/servers/AGENTS.md— wire protocols and network serverssrc/operator/AGENTS.md— statement, DDL/DML, and write orchestrationsrc/mito2/AGENTS.md— primary time-series storage enginesrc/metric-engine/AGENTS.md— metrics engine (logical/physical regions)src/flow/AGENTS.md— stream processing / continuous aggregationsrc/frontend/AGENTS.md— request entry point and orchestrationsrc/meta-srv/AGENTS.md— metadata and cluster coordinationtests/compatibility/AGENTS.md— persisted/wire compatibility casestests/perf/AGENTS.md— query regression harness and case DSL
Architecture invariants
architecture-invariants.md lists repo-wide rules
that are easy to violate and expensive to get wrong (format compatibility, crate
layering, async runtimes, error handling, feature gating, the DataFusion fork).
Generated files
generated-files.md lists tool-generated artifacts that
must not be hand-edited (sqlness .result, config.md, dashboards, ...).