文档更新
- 作者仓库星标 0
- 作者仓库 skills-registry
- 领域
- 文档
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @tomevault-io · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
## Pre-Commit Documentation Checklist
Before every commit, verify that ALL documentation is in sync with the code changes being committed. Run `git --no-pager diff --cached --name-only` (or `git --no-pager diff HEAD --name-only` for unstaged) to identify changed files, then check each doc category below.
### 1. ARCHITECTURE.md
Update `docs/ARCHITECTURE.md` if any of these changed:
- **Project structure tree** — new files/directories added or removed
- **Scene flow diagram** — scene transitions changed
- **Utility patterns** — new utilities created, existing ones changed
- **Lifecycle patterns** — shutdown cleanup, event listener patterns changed
- **Config/theme patterns** — new constants, theme values, or config patterns
- **Known gotchas** — new Phaser quirks, browser compat issues discovered
### 2. ROADMAP.md
Update `docs/ROADMAP.md`:
- **Backlog** — remove completed items, add new feature ideas
- **Known Issues** — add new bugs discovered, remove resolved items
- **Test Coverage Gaps** — update if tests were added or gaps identified
- **Deferred Refactors** — add new debt discovered, remove resolved items
### 3. GAMEPLAY.md
Update `docs/GAMEPLAY.md` if:
- Controls changed (keyboard, gamepad, touch)
- Level mechanics changed (objectives, hazards, scoring)
- New game features added (items, mechanics, zones)
### 4. ART_STYLE.md
Update `docs/ART_STYLE.md` if:
- Visual style changed (colors, textures, pixel art patterns)
- New visual elements added (markers, buildings, effects)
- UI styling changed (button styles, fonts, theme colors)
### 5. TESTING.md
Update `docs/TESTING.md` if:
- New test helpers or fixtures added to conftest.py
- New test patterns established
- Debugging techniques discovered
- Known flaky tests identified or resolved
### 6. In-Game Changelog
Update the changelog entries in `src/config/localization.ts` if:
- Any player-visible change was made (UI, controls, gameplay, visuals)
- Look for the `changelog` key in each language's translations
- Add a dated entry describing the change in user-facing language
### 7. Copilot Instructions
Update `.github/copilot-instructions.md` if:
- **Key files** changed (new important files, renamed files)
- **Critical patterns** changed (localStorage keys, placeholder syntax)
- **Quick commands** changed (new scripts, changed test commands)
- **Domain knowledge** changed (new game concepts, terminology)
- **Custom agents/skills** added or modified
- **Pre-commit checklist** itself needs updating
### 8. Skills and Agents
Update `.github/skills/` or `.github/agents/` if:
- Workflow processes changed (audit steps, review criteria)
- New tools or patterns should be codified for reuse
- Visual style rules changed (update art-review skill alongside ART_STYLE.md)
### 9. README.md
Update `README.md` if:
- **Features list** changed — new gameplay features, input methods, accessibility
- **Quick start / testing instructions** changed — new commands, new setup steps
- **Documentation table** changed — new docs added or renamed
- **Screenshots outdated** — significant visual changes warrant new screenshots. Use the `documentation-screenshots` skill to recapture them.
The README is the public face of the project. Keep it concise — detailed content belongs in `docs/`. Link to docs rather than duplicating.
## How to Apply
For each changed source file, ask: "Does this change affect any documentation?" Walk through categories 1–9 above. If a doc needs updating but the change is trivial (typo fix, internal refactor with no API change), skip it.
**Do NOT:**
- Update docs for changes that don't affect them
- Add verbose explanations — keep entries concise
- Create new doc files unless explicitly asked
- Update dates/timestamps in docs (they use git history)
**Do:**
- Keep the project structure tree in ARCHITECTURE.md current
- Keep ROADMAP.md as the single source of truth for work status
- Keep changelog entries in ALL 14 languages
- Keep copilot-instructions.md lean — it's injected into every prompt
- **Keep docs as few, long files** — Copilot CLI loads docs by file path; fewer files = fewer tool calls = faster context. Files up to ~3,000 lines are fine. Don't split a doc unless it exceeds ~5,000 lines. Related information in the same file helps the agent see connections it would miss across separate files.
---
> Source: [antoinecellerier/les-aiguilles-blanches](https://github.com/antoinecellerier/les-aiguilles-blanches) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 -->
章节与文件索引
按说明文件中的顺序排列。
预提交文档清单
1. 架构.md
2.路线图.md
3.游戏.md
4.ARTSTYLE.md
文件/命令 -> git --no-pager diff --cached --name-only · git --no-pager diff HEAD --name-only · docs/ARCHITECTURE.md · docs/ROADMAP.md · docs/GAMEPLAY.md · docs/ART_STYLE.md · docs/TESTING.md · src/config/localization.ts
内容校验值 -> b55f9219421e
当前原文的自动摘译,尚未人工审校。
预提交文档清单
在每次提交之前,验证所有文档是否与正在提交的代码更改同步。运行
git --no-pager diff --cached --name-only(或git --no-pager diff HEAD --name-only取消暂存)来识别已更改的文件,然后检查下面的每个文档类别。1. 架构.md
如果其中任何一项发生更改,请更新
docs/ARCHITECTURE.md: 项目结构树 — 添加或删除新文件/目录 场景流程图 — 场景转换已更改 实用程序模式 — 创建新实用程序,更改现有实用程序 生命周期模式 — 关闭清理、更改事件侦听器模式2.路线图.md
更新
docs/ROADMAP.md:待办事项 - 删除已完成的项目,添加新功能想法已知问题 - 添加发现的新错误,删除已解决的项目测试覆盖率差距 - 更新是否添加了测试或识别出差距延迟重构 - 添加发现的新债务,删除已解决的项目3.游戏.md
更新
docs/GAMEPLAY.md如果: 控件发生变化(键盘、游戏手柄、触摸) 关卡机制发生变化(目标、危险、得分) 添加新游戏功能(物品、机制、区域)4.ARTSTYLE.md
更新
docs/ART_STYLE.md,如果: 视觉样式发生变化(颜色、纹理、像素艺术图案) 添加新的视觉元素(标记、建筑物、效果) UI 样式发生变化(按钮样式、字体、主题颜色)