AGENT SKILL
common-best-practices
Universal clean-code principles for any environment. (triggers: **/*.ts, **/*.tsx, **/*.go, **/*.dart, **/*.java, **/*.kt, **/*.swift, **/*.py, solid, kiss, dry, yagni, naming, conventions, refactor, clean code)
适用职业开发工程师
- License 许可
- MIT
- 最近更新
- 2026-06-24
- Stars
- ★ 66
- Forks
- 24
01 前言 Front Matter
- name
- common-best-practices
- description
- Universal clean-code principles for any environment. (triggers: **/*.ts, **/*.tsx, **/*.go, **/*.dart, **/*.java, **/*.kt, **/*.swift, **/*.py, solid, kiss, dry, yagni, naming, conventions, refactor, clean code)
02 资源文件 1
- 其他customize.toml1.7 KB
03 SKILL.md 正文
Global Best Practices
Priority: P0 (FOUNDATIONAL)
? 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 "just in case" code.
- Naming: Intention-revealing (
isUserAuthenticated>checkUser). Follow language casing.
? Code Hygiene
- Size Limits: Functions < 30 lines. Services < 600 lines. Utils < 400 lines.
- Early Returns: Use guard clauses to prevent deep nesting.
- Comments: Explain why, not what. Refactor instead of commenting bad code.
- Sanitization: Validate all external inputs.
Anti-Patterns
- No hardcoded constants: Use named config/env vars.
- No deep nesting: Guard clauses eliminate the Pyramid of Doom.
- No global state: Prefer dependency injection.
- No empty catches: Always handle, log, or rethrow.
References
- Code Structure Patterns — file/function organization
- Effectiveness Guide — practical application examples
