mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-06-11 02:33:10 +08:00
8b24f63ede
Several published examples contained APIs that no longer exist, code that does not run, or model versions that drifted from reality: - agents/performance-optimizer.md used the web-vitals v3 API (getCLS/getFID/getLCP/getFCP/getTTFB) and reported FID. web-vitals v4 renamed the imports to onCLS/onINP/onLCP/onFCP/onTTFB and FID was replaced by INP (target < 200ms) - rules/common/performance.md pinned stale model versions in the model-selection guidance; refresh to the versions the repo itself uses (agent.yaml pins claude-opus-4-6) and add the PowerShell variant for MAX_THINKING_TOKENS next to the bash export - skills/python-patterns/SKILL.md: both get_value examples referenced default_value without declaring the parameter (NameError); add default_value: Any = None to the EAFP and LBYL signatures - skills/frontend-patterns/SKILL.md: the custom useQuery example rebuilt refetch whenever callers passed inline fetchers/options, re-triggering the effect after every state update (infinite fetch loop). Keep the latest fetcher/options in refs so refetch stays referentially stable. The PASS-labelled useMemo example mutated its input with in-place sort; copy before sorting - skills/coding-standards/SKILL.md repeated the same PASS-labelled in-place-sort-in-useMemo example; same fix - rules/typescript/security.md used a vendor-specific OPENAI_API_KEY in generic guidance; switch to a neutral API_KEY Every hand-maintained copy of the affected content is synced in the same change: locale mirrors (ja-JP, ko-KR, pt-BR, tr, zh-CN, zh-TW - each only where it carries the affected file) and the .agents/.kiro/.cursor harness mirrors. Two structural divergences are left alone and noted here: .kiro/steering/performance.md has no extended-thinking control list to carry the PowerShell variant, and docs/zh-TW/rules/performance.md keeps an older condensed thinking section without the budget-cap line. rules/zh/performance.md is intentionally untouched - the rules/zh tree is being retired in a separate change
规则
结构
规则被组织为一个通用层加上语言特定的目录：
rules/
├── common/ # 语言无关原则（始终安装）
│ ├── coding-style.md
│ ├── git-workflow.md
│ ├── testing.md
│ ├── performance.md
│ ├── patterns.md
│ ├── hooks.md
│ ├── agents.md
│ └── security.md
├── typescript/ # TypeScript/JavaScript 特定
├── python/ # Python 特定
├── golang/ # Go 特定
├── swift/ # Swift 特定
└── php/ # PHP 特定
- common/ 包含通用原则 —— 没有语言特定的代码示例。
- 语言目录 通过框架特定的模式、工具和代码示例来扩展通用规则。每个文件都引用其对应的通用文件。
安装
选项 1：安装脚本（推荐）
# Install common + one or more language-specific rule sets
./install.sh typescript
./install.sh python
./install.sh golang
./install.sh swift
./install.sh php
# Install multiple languages at once
./install.sh typescript python
选项 2：手动安装
重要提示： 复制整个目录 —— 不要使用
/*将其扁平化。 通用目录和语言特定目录包含同名的文件。 将它们扁平化到一个目录会导致语言特定的文件覆盖通用规则，并破坏语言特定文件使用的相对../common/引用。
# Install common rules (required for all projects)
cp -r rules/common ~/.claude/rules/common
# Install language-specific rules based on your project's tech stack
cp -r rules/typescript ~/.claude/rules/typescript
cp -r rules/python ~/.claude/rules/python
cp -r rules/golang ~/.claude/rules/golang
cp -r rules/swift ~/.claude/rules/swift
cp -r rules/php ~/.claude/rules/php
# Attention ! ! ! Configure according to your actual project requirements; the configuration here is for reference only.
规则与技能
- 规则 定义广泛适用的标准、约定和检查清单（例如，“80% 的测试覆盖率”、“没有硬编码的密钥”）。
- 技能（
skills/目录）为特定任务提供深入、可操作的参考材料（例如，python-patterns，golang-testing）。
语言特定的规则文件会在适当的地方引用相关的技能。规则告诉你要做什么；技能告诉你如何去做。
添加新语言
要添加对新语言的支持（例如，rust/）：
- 创建一个
rules/rust/目录 - 添加扩展通用规则的文件：
coding-style.md—— 格式化工具、习惯用法、错误处理模式testing.md—— 测试框架、覆盖率工具、测试组织patterns.md—— 语言特定的设计模式hooks.md—— 用于格式化工具、代码检查器、类型检查器的 PostToolUse 钩子security.md—— 密钥管理、安全扫描工具
- 每个文件应以以下内容开头：
> 此文件通过 <语言> 特定内容扩展了 [common/xxx.md](../common/xxx.md)。 - 如果现有技能可用，则引用它们，或者在
skills/下创建新的技能。
规则优先级
当语言特定规则与通用规则冲突时，语言特定规则优先（具体规则覆盖通用规则）。这遵循标准的分层配置模式（类似于 CSS 特异性或 .gitignore 优先级）。
rules/common/定义了适用于所有项目的通用默认值。rules/golang/、rules/python/、rules/swift/、rules/php/、rules/typescript/等会在语言习惯不同时覆盖这些默认值。
示例
common/coding-style.md 建议将不可变性作为默认原则。语言特定的 golang/coding-style.md 可以覆盖这一点：
符合 Go 语言习惯的做法是使用指针接收器进行结构体修改——关于通用原则请参阅 common/coding-style.md，但此处更推荐符合 Go 语言习惯的修改方式。
带有覆盖说明的通用规则
rules/common/ 中可能被语言特定文件覆盖的规则会标记为：
语言说明：对于此模式不符合语言习惯的语言，此规则可能会被语言特定规则覆盖。