xix-team/spec

开发规范

开发规范手册

1 原则

• 代码同出一门，保持整洁、易读、一致，码出质量、码出高效。
• 对待规范，要严格遵守；对待风格，要懂得尊重。
• 如果觉得有不合理或者遗漏的地方，请访问 New Issue。

2 目录

• JavaScript \ EMCAScript \ TypeScript 编码规范 [草稿]
• CSS \ Less \ Sass 编码规范 [草稿]
• HTML 编码规范 [草稿]
• 源码文件规范 [草稿]
• 目录结构规范 [草稿]
• 技术文档写作规范 [草稿]
• 包项目规范 [草稿]
• 业务项目规范 [草稿]

3 保障方法

• code format
  • 统一编辑器配置
• code lint
  • lint校验
• code inspect
  • webstorm inspect
  • sonar自动分析代码质量
• code review
  • 人工