mcpField
B
best-practices

best-practices

github.com/fradser开发596114 次安装5 周前更新
代码仓库

关于 best-practices

提供按语言和框架划分的编码参考，并补充通用代码质量规范的开发技能。它只应用检测到的框架规则，并要求重构保留原有行为和公共接口。

主要功能

  1. 01按文件扩展名映射语言参考
  2. 02提供 React 和 Next.js 规则索引
  3. 03仅应用已检测框架的规则
  4. 04优先处理性能与水合关键规则
  5. 05规范类型、错误处理与代码清理

适用场景

  1. 01查找适用于文件语言的编码建议
  2. 02应用相关的 React 或 Next.js 模式
  3. 03重构时检查代码质量
  4. 04使重构符合现有项目约定

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/fradser/dotclaude --skill best-practices

安装后在 Claude Code 中输入/best-practices确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
_template.md
go.md
python.md
references/python/
_sections.md
_template.md
fundamental-background.md
fundamental-exceptions.md
fundamental-future-imports.md
fundamental-global-state.md
fundamental-imports.md
fundamental-packages.md
fundamental-resources.md
fundamental-threading.md
INDEX.md
language-comprehensions.md
language-conditionals.md
language-decorators.md
language-default-args.md
language-generators.md
language-getters-setters.md
language-iterators.md
language-lambda.md
language-lexical-scoping.md
language-nested-classes.md
language-power-features.md
language-properties.md
language-true-false.md
quality-function-length.md
quality-lint.md
quality-main.md

详细介绍

最佳实践

语言参考

每种文件扩展名都对应特定的参考文档：

  • .ts、.js — references/typescript.md
  • .tsx、.jsx — references/typescript.md + references/react/react.md
  • .py — references/python.md + references/python/INDEX.md
  • .go — references/go.md
  • .swift — references/swift.md

通用原则见 references/universal.md。

Next.js/React 参考

对于 Next.js 项目，references/react/ 目录提供：

  1. references/react/rules/INDEX.md — 按影响级别编排的模式索引
  2. references/react/rules/_sections.md — 优先级和类别
  3. 与观察到的模式相匹配的具体规则文件

规则应用

  • 框架专属规则（例如 Next.js）仅在检测到相应框架时适用
  • CRITICAL 规则优先级最高：瀑布流、包体积、水合
  • 所有重构都必须保留行为和公共接口

代码质量标准

  • 注释：仅用于复杂的业务逻辑；重复说明代码内容的注释没有必要
  • 错误处理：仅在可恢复的情况下使用 try-catch；受信任的路径中无需防御性检查
  • 类型安全：不使用 any；必须使用适当的类型，或配合保护条件使用 unknown
  • 风格：优先遵循现有代码风格和 CLAUDE.md 约定
  • 清理：移除未使用的导入、变量、函数和类型
  • 不做兼容性权宜处理：删除未使用的 _vars 和已删除代码的重新导出
  • 重命名：优先使用描述性名称，而不是将其标记为未使用
  • 死代码：删除死代码，绝不将其注释掉
  • 文件组织：单一职责原则适用于文件级别；包含多个关注点的文件应考虑拆分（参见 references/universal.md）

评论

支持 Markdown