前端规范总览

良好的前端规范是团队协作的基石。它降低沟通成本、减少低级错误,并让代码在多人维护下依然保持可读、可维护。

为什么需要规范

  • 统一的代码风格让 Review 更高效
  • 统一的命名与目录结构降低认知负担
  • 明确的提交与分支规范让协作可追溯
  • 一致的 UI 规范提升产品体验一致性

规范体系

本栏目围绕以下几条主线展开:

  1. 代码风格规范:编辑器、Lint、格式化
  2. 组件设计规范:API、状态、可访问性
  3. 命名规范:文件、变量、组件、CSS
  4. Git 提交规范:分支、Commit、Review

如何落地

规范不是写给人看的文档,而是要落到工具链里:

  • 用 ESLint + Prettier 固化代码风格
  • 用 Git Hook(husky + lint-staged)卡住不规范提交
  • 用 CI 在合并前做校验
  • 定期回顾,随团队演进

本栏目导航

  • 代码风格规范
  • 组件设计规范
  • 命名规范
  • Git 提交规范