安装命令
npx skills add https://github.com/davidkiss/smart-ai-skills --skill coding🇨🇳中文介绍
通用编码最佳实践
概述
此技能提供了一套软件开发的核心原则和实践。在实现新功能、重构现有代码或审查代码时使用此技能，以确保高质量和可维护性。
核心原则
- DRY（不要重复自己）： 避免逻辑重复。如果你发现自己写了两次相同的代码，请将其抽象出来。
- KISS（保持简单，傻瓜）： 优先选择简单、直接的解决方案，而不是复杂的方案。避免过度设计。
- YAGNI（你不需要它）： 不要实现实际上不需要的功能或抽象。
- SOLID 原则：
- 单一职责原则：一个类/函数应该只有一个变更的理由。
- 开闭原则：软件实体应该对扩展开放，对修改关闭。
- 里氏替换原则：子类型必须可以替换其基类型。
- 接口隔离原则：多个特定于客户端的接口优于一个通用接口。
- 依赖倒置原则：依赖抽象，而非具体实现。
实施指南
- 整洁代码： 为变量、函数和类使用描述性的名称。编写易于阅读和理解的代码。
- 小型函数： 保持函数小巧并专注于单一任务。
- 错误处理： 使用主动的错误处理。验证输入并优雅地处理异常。
- 文档： 记录“为什么”，而不是“是什么”。尽可能使用自解释的代码。
- 安全性： 对输入进行清理，避免硬编码密钥，并遵循最小权限原则。
- 性能： 注意时间和空间复杂度，但要避免过早优化。
自动化分析与质量控制
- 静态分析与代码检查： 每个项目必须具备自动化的代码检查、格式化和静态分析（例如 ESLint、Prettier、Ruff、Sonar）。
- 检查： 识别这些工具是否已配置。
- 建议： 如果缺失，立即建议添加它们（例如
npm install --save-dev eslint）。
🇺🇸English
General Coding Best Practices
Overview
This skill provides a set of core principles and practices for software development. Use this when implementing new features, refactoring existing code, or reviewing code to ensure high quality and maintainability.
Core Principles
- DRY (Don't Repeat Yourself): Avoid logic duplication. If you find yourself writing the same code twice, abstract it.
- KISS (Keep It Simple, Stupid): Prefer simple, straightforward solutions over complex ones. Avoid over-engineering.
- YAGNI (You Ain't Gonna Need It): Don't implement features or abstractions until they are actually needed.
- SOLID Principles:
- Single Responsibility: A class/function should have one reason to change.
- Open/Closed: Software entities should be open for extension but closed for modification.
- Liskov Substitution: Subtypes must be substitutable for their base types.
- Interface Segregation: Many client-specific interfaces are better than one general-purpose interface.
- Dependency Inversion: Depend on abstractions, not concretions.
Implementation Guidelines
- Clean Code: Use descriptive names for variables, functions, and classes. Write code that is easy to read and understand.
- Small Functions: Keep functions small and focused on a single task.
- Error Handling: Use proactive error handling. Validate inputs and handle exceptions gracefully.
- Documentation: Document the why , not the what. Use self-documenting code where possible.
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者，精准高效
