agentleFS
Apprentice-GeoApprentice-Geo/skills/coding-guidelines/SKILL.md

coding-guidelines

Skill3 starsChanged 11 days agoApache-2.0View on GitHub

用于代码实现、审查、缺陷诊断和改动方案评估,指导范围判断、代码复用、信息组织、验证和结果汇报。

16 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use grill-me.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    grill-me

    A relentless interview to sharpen a plan or design.

    Also in 3 projects that use this

The file

Files
SKILL.md

编码准则

按任务类型应用相关规则,审查、诊断和方案评估以分析与建议为交付;代码修改依据用户请求执行。

用户的要求、仓库中的明确指令和项目约定的优先级高于本准则。

编码前先思考

先阅读相关代码并定位问题或理解需求,解决可能的歧义,分析需要改动的范围,再开始修改。

  • 先通过代码、文档和相关验证澄清关键不确定性,已有明确授权的事项按授权执行。
  • 若仍需用户决定任务范围、用户可见行为或契约取舍时,说明具体影响并询问。
  • 对于低风险细节,采用合理假设并继续,仅在假设影响结果理解时说明。
  • 谨慎参考仓库已有代码模式,它们未必是正确的范式。

控制改动范围

在明确目标和验收标准后,只执行完成任务所需的最小完整改动。

  • 仅在用户明确要求实现、修改或修复时执行改动;分析、审查、诊断和方案类请求默认只提供结论与建议。
  • 改动限于请求直接涉及或为正确性所必需的内容;不顺手重构、清理或扩展功能,额外问题单独汇报。
  • 优先复用仓库和依赖的已有功能;新增抽象、版本控制、配置或依赖应有必要性。
  • 保留无关的本地修改、未跟踪文件和用户创建的产物。
  • 按改动范围执行有价值的验证,不要机械运行无关检查,并如实报告通过、失败、未执行和受阻验证。

维护单一信息源

同类业务规则、设计规范、开发约束和知识应集中维护,并明确其单一权威实现或来源。

  • 语义和职责相同的功能应尽量只有一个实现,并由其它位置复用。
  • 相同事实或规则应有一个明确的权威来源,其它位置优先引用而非复制。
  • 对于关键的约束和规则边界,允许在文档中少量重复。

单一信息源的价值在于明确的信息组织,并减缓开发过程中的熵增。

保证测试质量

测试应保护可观察行为、明确契约或有实际价值的边界条件。

  • 对行为变更、bug 修复、业务规则和有实际意义的错误路径,优先编写回归测试。
  • 除非相关内容属于契约,否则避免测试 UI/CSS/DOM 的偶然结构、文档的精确措辞、私有实现细节、mock 调用顺序,以及文件、日志或缓存等副产物。
  • 未经授权,不修改、删除、放宽或跳过与当前改动无关的测试,也不得通过缩减 fixture、断言范围、测试环境或提高容差来掩盖回归。
  • 测试失败时,判断其保护的行为是否仍属于有效契约:若有效则修复实现;若与已确认的新行为冲突则同步更新测试。
  • 测试是验证手段而不是目的,不要为了满足 TDD、提高覆盖率或证明代码已编写而添加不必要的测试。

测试代码也需要维护,编写测试应出于实际需要而不是形式正确。

保持简要输出

用户的注意力和时间是稀缺资源,回复用户的内容应保持简洁明确。

  • 直接给出结果、相关验证状态和其它影响判断的信息,不复述用户要求、显而易见的内容或无必要的执行过程
  • 简洁不得以省略失败、风险、不确定性或未完成验证为代价。
  • 使用准确的技术术语,并保持需要的代码块和关键报错信息不变。

默认给出足以支持用户下一步判断的最短回复,用户要求解释时再展开。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.