技术团队文档

技术团队文档


提交规范

<h3>代码检查工具</h3> <ul> <li> <p><strong>Eslint</strong></p> </li> <li> <p>项目集成</p> <pre><code>npm i eslint -D npx eslint --init</code></pre> </li> </ul> <h4>代码风格工具</h4> <ul> <li> <p><strong>prettier</strong></p> </li> <li> <p>项目集成</p> <pre><code>npm i prettier eslint-config-prettier eslint-plugin-prettier -D</code></pre> <p>创建 .prettierrc</p> <pre><code>// 根据所需进行配置 { "semi": false, "tabWidth": 2, "trailingComma": "none", "singleQuote": true, "arrowParens": "avoid" }</code></pre> </li> </ul> <h3>git 提交代码规范</h3> <p>执行<code>npm run commit</code>命令,根据提示流程选择本次提交类型和范围,进行代码提交流程</p> <ul> <li> <p><strong>commitizen</strong> -- 辅助 commit 信息,规范提交信息</p> </li> <li><strong>commitizen</strong> -- cz-config 设置提交模板</li> </ul> <h3>提交规范配置</h3> <p>-- 规范配置,标识采用什么规范来执行消息校验, 这个默认是Angular的提交规范</p> <table> <thead> <tr> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>build</td> <td>编译相关的修改,例如发布版本、对项目构建或者依赖的改动</td> </tr> <tr> <td>chore</td> <td>其他修改, 比如改变构建流程、或者增加依赖库、工具等</td> </tr> <tr> <td>ci</td> <td>更改持续集成软件的配置文件和 package 中的 scripts 命令</td> </tr> <tr> <td>docs</td> <td>文档修改</td> </tr> <tr> <td>feat</td> <td>新需求、新功能</td> </tr> <tr> <td>fix</td> <td>修改bug</td> </tr> <tr> <td>perf</td> <td>性能优化相关,比如提升性能、用户体验</td> </tr> <tr> <td>refactor</td> <td>代码重构,代码优化</td> </tr> <tr> <td>revert</td> <td>代码回退</td> </tr> <tr> <td>style</td> <td>代码格式(不影响功能,例如空格、分号等格式修正)</td> </tr> </tbody> </table>

页面列表

ITEM_HTML