| name | code-quality |
| description | 代码质量标准 - 编码风格规范、安全指南和无障碍要求。适用于:(1) 编写新代码 (2) 代码风格/安全审查 (3) 实现UI/UX功能 (4) 处理安全问题 (5) 确保无障碍合规。涵盖命名约定、格式化、安全最佳实践(禁止泄露密钥/个人敏感信息)、无障碍标准(语义化HTML、键盘导航)和响应式设计。 |
代码质量标准
编码风格
- 命名规范: 变量/函数使用 camelCase;类/类型使用 PascalCase
- 格式化: 4 空格缩进;目标行宽 ≤80 字符(合理换行)
- 注释: 有意义且最新的注释;删除过时的注释
- 安全: 绝不记录密钥/个人敏感信息;验证输入;默认最小权限原则
- 错误/日志: 明确的错误类型;按级别记录结构化日志;提供可操作的消息
无障碍与用户体验质量
- 优先使用语义化角色/标签;键盘导航和焦点顺序必须正常工作
- 在 375, 768, 1024, 1440 像素断点处包含响应式检查,并附注说明/截图
- 使用确定性的测试 ID;避免脆弱的 CSS/XPath 选择器
安全与合规防护
- 代码、测试和截图中不得包含真实的凭证
- 使用测试账号/固件数据;脱敏处理密钥
- 遵循最小权限和输入验证原则
- 在相关情况下,在 PR 中记录安全威胁考虑
参考文件
查看 references/coding-style.md 获取详细的风格指南、格式化规则和注释标准。
查看 references/security-checklist.md 获取安全验证清单、威胁建模和个人敏感信息处理指南。
查看 references/accessibility-standards.md 获取 WCAG 合规指南、语义化 HTML 模式和键盘导航测试。