Skip to main content

coding-standards

Universal coding standards, best practices, and patterns for development.

来源信息

仓库
zekdevs/pi-config
最近来源活动
2026年5月17日 04:55
检测到的 SKILL.md 语言
英语
星标
34
分支
3

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
coding-standards
description
Universal coding standards, best practices, and patterns for development.
# Coding Standards & Best Practices Universal coding standards applicable across all projects. ## Code Quality Principles ### 1. Readability First - Code is read more than written - Clear variable and function names - Self-documenting code preferred over comments - Consistent formatting ### 2. KISS (Keep It Simple, Stupid) - Simplest solution that works - Avoid over-engineering - No premature optimization - Easy to understand > clever code ### 3. DRY (Don't Repeat Yourself) - Extract common logic into functions - Create reusable components - Share utilities across modules - Avoid copy-paste programming ### 4. YAGNI (You Aren't Gonna Need It) - Don't build features before they're needed - Avoid speculative generality - Add complexity only when required - Start simple, refactor when needed ## API Design Standards ### REST API Conventions ``` GET /api/markets # List all markets GET /api/markets/:id # Get specific market POST /api/markets # Create new market PUT /api/markets/:id # Update market (full) PATCH /api/markets/:id # Update market (partial) DELETE /api/markets/:id # Delete market # Query parameters for filtering GET /api/markets?status=active&limit=10&offset=0 ``` **Remember**: Code quality is not negotiable. Clear, maintainable code enables rapid development and confident refactoring.
在 GitHub 查看