mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-08 10:54:50 +00:00
Qiu Yuzhou
a335e00a38
对照 ~/.agents/skills/setup-matt-pocock-skills 的当前模板逐字节核对三份配置： - triage-labels.md 与模板完全一致，无漂移，未改动。 - domain.md 同步标点（— 改为 :）与措辞（Single-context repo (this repo) 改为 (most repos)），现与模板一致。 - issue-tracker.md 同步标点漂移，并把硬编码的 --repo qiuyuzhou/ShadowsocksX-NG 换成从 clone 推导 （gh repo view --json nameWithOwner）后显式 pin。保留「绝不写入其他仓库」的 安全规则与那次误发事故的教训，但去掉仓库名，使该配置在合并进上游后仍然成立。 AGENTS.md 的一行摘要同步去掉仓库名。 .scratch/ 加入 .gitignore 与 .zcodeignore：这是 setup-matt-pocock-skills 为 local-markdown tracker 约定的目录，切到本地 tracker 时 spec 文件不落进 git。 docs/design/ 与 docs/research/ 的去留尚未决定，本次不引入任何排除机制。
52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
# Domain Docs
|
|
|
|
How the engineering skills should consume this repo's domain documentation when exploring the codebase.
|
|
|
|
## Before exploring, read these
|
|
|
|
- **`GLOSSARY.md`** at the repo root, or
|
|
- **`GLOSSARY-MAP.md`** at the repo root if it exists: it points at one `GLOSSARY.md` per context. Read each one relevant to the topic.
|
|
- **`docs/adr/`**: read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
|
|
|
|
If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
|
|
|
|
## File structure
|
|
|
|
Single-context repo (most repos):
|
|
|
|
```
|
|
/
|
|
├── GLOSSARY.md
|
|
├── docs/adr/
|
|
│ ├── 0001-event-sourced-orders.md
|
|
│ └── 0002-postgres-for-write-model.md
|
|
└── src/
|
|
```
|
|
|
|
Multi-context repo (presence of `GLOSSARY-MAP.md` at the root):
|
|
|
|
```
|
|
/
|
|
├── GLOSSARY-MAP.md
|
|
├── docs/adr/ ← system-wide decisions
|
|
└── src/
|
|
├── ordering/
|
|
│ ├── GLOSSARY.md
|
|
│ └── docs/adr/ ← context-specific decisions
|
|
└── billing/
|
|
├── GLOSSARY.md
|
|
└── docs/adr/
|
|
```
|
|
|
|
## Use the glossary's vocabulary
|
|
|
|
When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `GLOSSARY.md`. Don't drift to synonyms the glossary explicitly avoids.
|
|
|
|
If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
|
|
|
|
## Flag ADR conflicts
|
|
|
|
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
|
|
|
|
> _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_
|