common-best-practices

分类: 开发与编程 | 上传者: HoangNguyen0403 | 下载: 0 | 版本: v1.0（最新）

在所有语言中强制执行 SOLID 原则、保护子句样式、函数大小限制和意图揭示的命名。在重构可读性、应用干净代码模式、检查命名约定或降低函数复杂性时使用。（触发：**/*.ts、**/*.tsx、**/*.go、**/*.dart、**/*.java、**/*.kt、**/*.swift、**/*.py、solid、kiss、dry、yagni、命名、约定、重构、干净代码）

更新日志: Source: GitHub https://github.com/HoangNguyen0403/agent-skills-standard

目录结构

当前层级: tree/develop/.agent/skills/common/common-best-practices/

📁 references/
- 📄 CODE_STRUCTURE.md 1.0 KB
- 📄 EFFECTIVENESS.md 1.5 KB
📄 SKILL.md 1.5 KB

SKILL.md

---
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. (triggers: **/*.ts, **/*.tsx, **/*.go, **/*.dart, **/*.java, **/*.kt, **/*.swift, **/*.py, solid, kiss, dry, yagni, naming, conventions, refactor, clean code)"
---

# 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](references/CODE_STRUCTURE.md) — file/function organization
- [Effectiveness Guide](references/EFFECTIVENESS.md) — practical application examples

登录后下载/点赞/收藏 ❤ 373 | ★ 0

common-best-practices

目录结构

SKILL.md

举报内容

提示