Code Quality

🛡️ 代码规范·安全合规·无障碍标准一站式指南

代码质量规范助手,覆盖编码风格、安全合规、无障碍访问标准,适用于代码编写、审查及UI开发场景,确保可维护性与安全性。

收藏
7.6k
安装
2.4k
版本
1.0.0
CLS 安全性认证2026-06-04
点击查看完整报告 >

使用说明

核心用法

code-quality 技能为开发团队提供统一的代码质量规范,主要应用于五大场景:新代码编写、代码风格与安全审查、UI/UX功能实现、安全问题处理、无障碍合规检查。

编码风格方面,该技能确立了明确的命名约定(camelCase变量/函数、PascalCase类/类型)、4空格缩进格式、80字符行宽限制,以及有意义的注释规范,强调及时清理过时注释以保持代码可维护性。

安全合规层面,核心原则包括:绝不记录密钥/个人身份信息(PII)、严格输入验证、默认最小权限原则。错误处理要求显式错误类型、结构化日志分级,确保消息可操作。

无障碍与UX质量要求优先使用语义化角色与标签,键盘导航和焦点顺序必须可用,并规定在375、768、1024、1440四个断点进行响应式检查。测试建议使用确定性ID,避免脆弱的CSS/XPath选择器。

安全合规 guardrails 明确禁止在代码、测试或截图中使用真实凭证,强制使用测试账户/夹具并脱敏处理敏感信息。PR中需文档化威胁考量。

显著优点

1. 覆盖面完整:将编码风格、安全、无障碍三大质量维度整合为单一技能
2. 可操作性强:提供具体数值标准(行宽80字符、四个响应式断点)和明确禁用项

3. 安全优先设计:从代码编写源头嵌入安全思维,而非事后检查

4. 无障碍内置:将WCAG合规要求前置到开发流程,降低合规成本

潜在局限

  • 未指定具体技术栈(Java/ Python/ Node.js等),团队需自行映射到语言特定规范
  • 80字符行宽在现代宽屏环境中可能存在争议
  • 依赖外部参考文件(references/目录),实际可用性取决于文件维护状态

适合人群

前端/全栈开发者、代码审查者、安全合规专员、需要满足WCAG无障碍要求的产品团队,以及建立代码规范的新团队或重构项目。

常规风险

  • 规范执行依赖人工审查,缺乏自动化检测集成说明
  • "有意义注释"等主观标准可能引发团队解读分歧
  • 四个断点覆盖可能不足以应对特定设备生态(如折叠屏、超宽屏)

安全解读

核心功能与用法

code-quality 是一款纯文档型代码质量指南 Skill,旨在为开发团队提供统一的编码规范、安全最佳实践和可访问性(Accessibility)标准。该 Skill 无执行代码、无外部依赖,通过 Markdown 文档形式嵌入开发工作流。

核心用法场景

1. 编写新代码时:参照命名规范(camelCase/PascalCase)、格式化标准(4空格缩进、80字符换行)
2. 代码评审阶段:检查安全合规性(禁止日志输出密钥/PII、输入验证、最小权限原则)

3. UI/UX 实现时:确保语义化 HTML、键盘导航可用性、响应式设计(375/768/1024/1440 断点测试)

4. 安全漏洞修复:参考安全清单进行威胁建模和隐私数据处理

显著优点

  • 零安全风险:纯 Markdown 文档,无可执行代码,通过 S+ 顶级安全认证
  • 权威合规:涵盖 OWASP 安全原则、WCAG 可访问性标准、GDPR/CCPA 隐私合规
  • 即开即用:无需配置环境,直接作为参考手册使用
  • 多维度覆盖:从代码风格到安全、从可访问性到响应式设计,形成完整质量体系

潜在局限

  • 非强制约束:作为指南文档,需配合 CI/CD 工具或代码审查流程才能形成强制执行
  • 技术栈局限:未针对特定框架(React/Vue/Angular)提供定制化规则
  • 更新依赖:安全规范需人工维护,建议建立年度审查机制

适用人群

  • 前端/全栈开发者:需要统一团队代码风格
  • 技术负责人:建立团队代码质量基线
  • 安全工程师:快速落地安全编码规范
  • 无障碍工程师:实施 WCAG 合规检查

风险提示

  • 该 Skill 本身无风险,但需注意:文档中的规范需结合实际项目工具链(ESLint、Prettier、axe-core 等)才能有效落地
  • 建议补充许可证声明(当前未声明)以增强开源可信度

Code Quality 内容

手动下载zip · 1.2 kB
SKILL.mdtext/markdown
请选择文件