From 47f90f16bbf03c709056b371417fa8707edcadff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francesco=20Borz=C3=AC?= Date: Thu, 20 Aug 2026 21:00:49 +0200 Subject: [PATCH] docs(Agents): minor improvements (#27211) --- .agents/README.md | 24 ++++++++++++++++++------ .github/README.md | 1 + .gitignore | 2 ++ AGENTS.md | 1 + 4 files changed, 22 insertions(+), 6 deletions(-) diff --git a/.agents/README.md b/.agents/README.md index fe90911090..19cd61fbb7 100644 --- a/.agents/README.md +++ b/.agents/README.md @@ -1,17 +1,29 @@ # .agents -Source of truth for this repo's agent skills, rules, and docs: +Source of truth for this repo's agent skills and docs: - `skills//SKILL.md` -- `rules/.md` - `docs/` — task-scoped agent docs; taxonomy and placement policy in `docs/README.md` +- `plans/` — per-task planning docs, gitignored -Agent-specific directories expose skills and rules via a relative symlink — for Claude Code: +Conventions live in `AGENTS.md` and `docs/`. Agent-specific files point there instead of restating +them, so there is one copy to keep current. - .claude/skills/ -> ../../.agents/skills/ - .claude/rules/.md -> ../../.agents/rules/.md +## Hooking up your agent -To add a skill or rule: create it here, then symlink it. Docs need no symlinks — AGENTS.md references them by path. +- **Claude Code** — reads `CLAUDE.md`, which imports `AGENTS.md`. Skills are exposed by a relative + symlink: `.claude/skills/ -> ../../.agents/skills/`. +- **GitHub Copilot** — reads `AGENTS.md` natively. Code review also reads + `.github/copilot-instructions.md`; custom agent profiles live in `.github/agents/`. +- **Any other agent** — point it at `AGENTS.md` through its own entry file (`GEMINI.md`, + `.cursorrules`, …), using that agent's include syntax or, where includes are unsupported, a line + telling it to read `AGENTS.md` first. + +To add a skill: create it here, then symlink it from each agent's skills dir. Docs need no +symlinks — AGENTS.md references them by path. + +On Windows, symlinks need `git config core.symlinks true` plus Developer Mode or an elevated shell; +without them git checks the links out as plain text files. The skills in this repository often build on those from [agent-toolkit](https://github.com/eai-org/agent-toolkit/), invoking them when available. diff --git a/.github/README.md b/.github/README.md index 9150a42239..add26ce523 100644 --- a/.github/README.md +++ b/.github/README.md @@ -60,6 +60,7 @@ We also recommend you read our [Contributor Covenant Code of Conduct](https://gi Feel free to join our [Discord server](https://discord.gg/gkt4y2x). 🤖 If you use any AI agent to work on AzerothCore, please read our [AI Agentic Engineering guidelines](https://www.azerothcore.org/wiki/agentic-engineering). +Agent instructions for this repo live in [AGENTS.md](../AGENTS.md), with task-scoped guides in [.agents/docs/](../.agents/docs/); [.agents/README.md](../.agents/README.md) explains how to hook up your agent. Click on the "⭐ Star" button to help us gain more visibility on GitHub! diff --git a/.gitignore b/.gitignore index dea151f5b2..6e6ad78f44 100644 --- a/.gitignore +++ b/.gitignore @@ -65,6 +65,8 @@ CMakeLists.txt.user .claude/worktrees .claude/settings.local.json .claude/plans/** +.claude/.cc-writes/ +CLAUDE.local.md # # IDE & other software diff --git a/AGENTS.md b/AGENTS.md index 377a814f5f..54745bec6a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,6 +7,7 @@ AzerothCore is a C++ MMORPG server emulator for World of Warcraft 3.3.5a (WotLK) - **Do not configure or build unless explicitly asked.** Builds are slow and rarely needed for code changes. - **Never edit SQL files outside `data/sql/updates/pending_db_*/` unless explicitly requested.** `data/sql/base/`, `data/sql/archive/`, and `data/sql/updates/db_*/` are immutable. - Formatting follows `.editorconfig`: UTF-8, LF, max 120 cols, trailing newline, no trailing whitespace; 4-space indent for C++ (tabs forbidden), 2-space for JSON/YAML/sh/ts/js. +- Planning docs go in `.agents/plans//` (gitignored), named `..md` (`PLAN`, `REQUIREMENTS`, `ANALYSIS`, …). ## Mandatory reading per task