返回 Skill 列表
extension
分类: 开发与工程无需 API Key

rules-repo-conventions

应用规则仓库的约定和仅向前的工作流程。在为使用此仓库的项目生成或编辑文档、提示或代码时,或者当此仓库是活动工作区时使用。确保创建并更新Pact → Rules → Guides → Implementation链接,并且优先选择链接到子模块指南而不是复制内容。

person作者: jakexiaohubgithub

Rules Repository Conventions

This Skill encodes the essential conventions for working with this repository (as a submodule or directly) so Claude can apply them automatically.

Instructions

  1. Load and apply the repository root skills catalog: see skills.md.
  2. Honor RULES.md anchors for behavior and technical commitments:
  3. Close loops between artifacts:
    • Pact → Rules → Guides → Implementation, and back-links from Implementation to its source guide and rule.
  4. Link discipline:
    • Use relative paths; do not place project-specific docs inside the Rules Repository submodule directory when used downstream.
  5. Observability defaults:
  6. When adding new topic docs under generative/:
    • Add the entry to the nearest topic index README and cross-link to related guides.
  7. When updating structure/content:
    • Apply the Forward-Only policy in one change: update or remove conflicting docs and links; no compatibility stubs.

Examples

  • When scaffolding a new host project README, include links to PACT.md, RULES.md, GUIDES.md, IMPLEMENTATION.md, and the Rules Repository submodule path.
  • When creating a new Observability guide, add it to generative/platform/observability/README.md and cross-link from related platform indexes.

Validation Checklist

  • Links resolve and remain relative
  • Loop closure present (forward/back links)
  • No project-specific files placed inside the submodule directory
  • Forward-only edits applied (no legacy anchors retained)

See also