affaan-m/coding-standards

TypeScript、JavaScript、React 和 Node.js 开发的通用编码标准、最佳实践与模式。

编程协作开发 Agent Agent 技能调研 skill agent-skill coding standards affaan-m ECC ai-agent

技术栈: cursor24万+许可证: MIT开发者: affaan-m

Skill 介绍Skill 文件

重要提示：本站仅作 Skill 资源导航与收录，正文以 GitHub 原仓库为准，版权归原项目所有。

在 GitHub 查看 ↗

原文译文

以下为摘要预览，完整内容请查看 GitHub 原文。

编码标准与最佳实践

适用于所有项目的通用编码标准。

何时启用

启动新项目或新模块时
为代码质量和可维护性进行代码审查时
重构现有代码以遵循规范时
需要强制统一命名、格式或结构时
配置 lint、格式化或类型检查规则时
帮助新贡献者熟悉编码规范时

代码质量原则

1. 可读性优先

代码被阅读的次数远多于被编写的次数
使用清晰的变量和函数命名
优先选择自文档化的代码，而非大量注释
保持格式的一致性

2. KISS（Keep It Simple, Stupid — 保持简单）

选择能解决问题的最简方案
避免过度设计
不要过早优化
易懂的代码 > 聪明的代码

3. DRY（Don't Repeat Yourself — 不要重复自己）

将公共逻辑抽取为函数
创建可复用的组件
在模块间共享工具函数
避免复制粘贴式编程

4. YAGNI（You Aren't Gonna Need It — 你不会需要它）

不要构建尚未需要的功能
避免投机性的泛化
仅在必要时才引入复杂性
从简单开始，按需重构

TypeScript/JavaScript 规范

变量命名

// PASS：好：具有描述性的名称
const marketSearchQuery = 'election'
const isUserAuthenticated = true
const totalRevenue = 1000

// FAIL：坏：含义不清的名称
const q = 'election'
const flag = true
const x = 1000

函数命名

// PASS：好：动词-名词形式
async function fetchMarketData(marketId: string) { }
function calculateSimilarity(a: number[], b: number[]) { }
function isValidEmail(email: string): boolean { }

// FAIL：坏：含糊或仅使用名词
async function market(id: string) { }
function similarity(a, b) { }
function email(e) { }

不可变模式（关键）

// PASS：务必使用展开运算符
const updatedUser = {
  ...user,
  name: 'New Name'
}

const upda…

重要提示：源文件不在本站托管，请通过 GitHub 查看与下载。

索引更新于 8/25/2026, 9:18:05 PMGitHub ↗

SKILL.md12.4 KB在 GitHub 查看 ↗

相关资源

按类型、任务、场景与标签加权推荐

itsPremkumar/mcptest

MCP · Model · Context · Protocol · 测试工具 · 调试 · 开发框架

Automated MCP Server Testing Framework

yair4Data/mcp-security-analyzer

MCP · 安全审计 · 配置扫描 · 权限分析 · 开发工具

Comprehensive security testing framework for Model Context Protocol (MCP) server

Web Search Agents by Nimble

web · search · real-time · data · AI · agent · scraping · structured

网络搜索代理是针对您特定领域（例如公司信息丰富、法规研究等）的专业网络爬虫和研究代理。它们会自主学习您的使用场景，深入挖掘对您最重要的资源，从而为您的 AI 提供更深入、更相关的网络上下文

Demovanta

AI · Agent · 演示平台 · 评测 · 开发工具

。只需粘贴URL，一个真实浏览器就会打开你的网页，模拟浏览操作，并用你的母语旁白讲解屏幕上的内容

Krevios

AI代理 · 企业自动化 · 研究 · 工作流

你可以生成与编辑图像、制作视频、合成文本与排版——全程只需以可视化方式连接节点，无需编写代码

master-agreement-generator

流程自动化

根据一份模板与一份 JSON 规范生成对手方主协议的审阅稿，使用按角色选择的条款，并将 Schedule A 工作流限制在已签署协议的指定通知权限范围内。当需要…

25万+