根据日常开发总结的一些个人习惯规范。

Git Commit

参考 Angular 的提交约束 <type>: <summary>

type 有如下选项：

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests

Angular: commit message format

尝试使用 gitmoji，看起来很有意思：<type>: <emoji> <summary>

查看 gitmoji 图标与解释：gitmoji.dev

书写规范

  • 中英文中，英文前后要用空格间隔，中英文符号对应使用
  • 英文书籍，文章以英文斜体表示，中文书籍，文章用书名号
  • 推荐文章：中文文案排版细则
  • markdown 格式请使用 markdownlint 规范

组件规范

文件或文件夹的命名规范：

  • 全局通用组件统一文件夹。
  • 页面的组件放在各自页面 ./components 文件夹下。
  • 文件夹命名都 kebab-case 规范。
  • 默认导出文件为 index，index 文件只负责导出。
  • 组件或类文件使用大写 PascalCase 命名。