界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
开发与工程 · SKILL.md

common-best-practices

common-best-practices

【开发与工程】Enforce SOLID principles, guard-clause style, function size limits, and intention-revealing naming across all languages. Use when refactoring for readability, applying clean-code patterns, reviewing naming conventions, or reducing function complexity.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: common-best-practices description: Enforce SOLID principles, guard-clause style, function size limits, and intention-revealing naming across all languages. Use when refactoring for readability, applying clean-code patterns, reviewing naming conventions, or reducing function complexity. metadata: triggers: files: - '/*.ts' - '/.tsx' - '**/.go' - '/*.dart' - '/.java' - '**/.kt' - '/*.swift' - '/*.py' keywords: - solid - kiss - dry - yagni - naming - conventions - refactor - clean code

Global Best Practices

Priority: P0 (CRITICAL)

Core Principles

  • SOLID: Follow SRP (One reason to change), OCP (Open to extension), LSP, ISP, DIP.
  • KISS/DRY/YAGNI: Favor readability. Abstract repeated logic. No " in case" code.
  • Naming: Use intention-revealing names (isUserAuthenticated > checkUser). Match language casing.

Code Hygiene

  • Size Limits: Functions < 30 lines. Services < 600 lines. Utils < 400 lines.
  • Early Returns: Use guard clauses. Avoid deep nesting.
  • Comments: Explain why, not what. Refactor bad code; don't comment it.
  • Input: Validate/sanitize all external inputs.

Anti-Patterns

  • No Hardcoded Constants: Use named config/env vars.
  • No Deep Nesting: Use guard clauses.
  • No Global State: Prefer dependency injection.
  • No Empty Catches: Always handle, log, or rethrow.

References

我的收藏