coding-standards SKILL.md skillA
coding-standards from shinpr/ai-coding-project-boilerplate is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add shinpr/ai-coding-project-boilerplate/coding-standards@git:20261014.f06813cPins git:20261014.f06813c in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- shinpr/ai-coding-project-boilerplate
- Path
.claude/skills-zh-CN/coding-standards/SKILL.md- Versions recorded
- 7
- Latest version
- git:20261014.f06813c, committed Oct 14, 2026
- First version recorded
- Aug 31, 2026
- Size
- 13,000 bytes
- Repository stars
- 234
- License
- MIT
检测代码异味、反模式和可读性问题。在实现功能、评审代码或重构时使用。.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 通用编码标准 ## 技术反模式（危险信号模式） 检测到以下任一模式时，暂停实现并记录：触发的模式、受影响的当前需求、最小的合规替代方案，以及恢复所需的验证。当替代方案消除该模式或有文档记录的需求证明保留该模式合理时，方可恢复。 ### 代码质量反模式 1. **相似代码编写 3 次或以上** —— 违反三次法则（Rule of Three） 2. **单个文件中混杂多种职责** —— 违反单一职责原则（SRP） 3. **在多个文件中定义相同内容** —— 违反 DRY 原则 4. **未检查依赖关系就进行修改** —— 存在意外影响的可能性 5. **用注释禁用代码** —— 应使用版本控制 6. **错误抑制** —— 隐藏问题会形成技术债 7. **用类型断言替代保证** —— 声明了既无运行时检查也无既有契约作为依据的类型 ### 设计反模式 - **“暂时能用就行”的思维** —— 技术债的累积 - **补丁式实现** —— 对现有代码进行无计划的追加 - **对症式修复** —— 不解决根本原因的表面修复 - **无计划的大规模变更** —— 缺乏渐进式方法 ## 基本原则 持续排查，直到依据能够确定在保持系统正确性和可维护性的前提下，以最低总复杂度交付所需的用户、运维或维护者价值的方案。 - **基于依据的重构范围** —— 只重构阻碍当前结果、被当前任务变更、或未通过适用质量检查的代码；使用保持行为不变的小步骤。对其他发现，连同其所属边界和依据一并报告，而不扩大当前变更范围 - **仅限当前需求的代码** —— 只有当当前需求、已验证的约束、或有依据支持的实质性风险要求时，才引入新的代码路径、能力、基础设施、抽象或推测性的边缘情况处理（YAGNI） - **设计收敛** —— 以最小的设计增量交付当前所需的结果。在引入持久状态、公共或跨边界契约、行为模式、可复用抽象或组件拆分之前，先记录现有能力已经交付了什么、它们在当前结果上未能交付什么，以及为什么该新增是能弥合这一差距的最小方案 对每个被激活的层面综合评估总复杂度：用户决策、设置、模式、概念、输出、持久状态和实现路径，以及它们各自在 UX、运行时、实现、测试、文档和维护方面的成本。只比较各可行方案之间存在差异的维度。当能以更低的总复杂度交付相同的已确认价值和验证结果时，优先选择复用或不引入新机制。 ## 注释编写规则 - **代码优先**：命名、类型和结构是主要的表达媒介；只有在注释能传达代码无法表达的信息时才添加注释。犹豫不决时，改进命名而不是加注释 - **注释“为什么”，而非“是什么”**：解释推理过程、权衡取舍、约束/边缘情况，或公共 API 契约 - **内容不过时**：注释包含当前的推理、约束、边缘情况或 API 契约；开发历史由版本控制保留 …
Read the whole file at its exact version.
How to install
mdr add shinpr/ai-coding-project-boilerplate/coding-standards@sha256:8fa8260550ba4352The line at the top of this page pins the label git:20261014.f06813c, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_iltavn7gejomvfva)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 7 versions of this file, between Aug 31, 2026 and Oct 14, 2026, about one every 7 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261014.f06813c latest | 2026-10-14 | f06813c | 13,000 B | A | view · diff |
| git:20261012.a0476f0 | 2026-10-12 | a0476f0 | 13,476 B | A | view · diff |
| git:20260923.03f66be | 2026-09-23 | 03f66be | 13,446 B | A | view · diff |
| git:20260923.86a3d79 | 2026-09-23 | 86a3d79 | 14,290 B | A | view · diff |
| git:20260912.c0d4362 | 2026-09-12 | c0d4362 | 13,915 B | A | view · diff |
| git:20260906.388b1dd | 2026-09-06 | 388b1dd | 13,882 B | A | view · diff |
| git:20260831.b183037 | 2026-08-31 | b183037 | 13,960 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (13000 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
shinpr/ai-coding-project-boilerplate · 234 stars · license MIT · pushed 2026-10-14 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_iltavn7gejomvfva GET https://markdownregistry.com/api/v1/resolve?ref=shinpr/ai-coding-project-boilerplate/coding-standards GET https://markdownregistry.com/api/v1/blob/8fa8260550ba4352d943ca8c0360e260b90bcee913df29689085b03658c5bce8
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from shinpr/ai-coding-project-boilerplate
Every file in shinpr/ai-coding-project-boilerplate