From 9a9d4d21e474ebfc3c2b7a66d4b84611df3af75e Mon Sep 17 00:00:00 2001 From: xiangshu233 Date: Fri, 16 Feb 2024 19:10:10 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20:memo:=20=E6=9B=B4=E6=96=B0=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 增加提交校验简要说明 --- README.md | 115 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 84 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 3252462..191edb5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@
Vue3Vant4MobileLogo -


@@ -26,28 +25,28 @@ ## 截图预览 - - - - - + + + + + - - + +
登录页面主控台页(首页）
登录页面主控台页(首页）
消息页（图标页）我的（我的信息页面）
我的（我的信息页面）
展开预览暗黑模式下的界面截图。 - - - - - + + + + + - - + +
登录页面（暗黑模式）主控台页（暗黑模式）
登录页面（暗黑模式）主控台页（暗黑模式）
我的页面（暗黑模式）主题设置页面（暗黑模式）
主题设置页面（暗黑模式）
@@ -120,20 +119,74 @@ pnpm build ## Git 贡献提交规范 -- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) - - `feat` 增加新功能 - - `fix` 修复问题/BUG - - `style` 代码风格相关无影响运行结果的 - - `perf` 优化/性能提升 - - `refactor` 重构 - - `revert` 撤销修改 - - `test` 测试相关 - - `docs` 文档/注释 - - `chore` 依赖更新/脚手架配置修改等 - - `workflow` 工作流改进 - - `ci` 持续集成 - - `types` 类型定义文件更改 - - `wip` 开发中 +### 提交规范 + +参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) + +- `feat` 增加新功能 +- `fix` 修复问题/BUG +- `style` 代码风格相关无影响运行结果的 +- `perf` 优化/性能提升 +- `refactor` 重构 +- `revert` 撤销修改 +- `test` 测试相关 +- `docs` 文档/注释 +- `chore` 依赖更新/脚手架配置修改等 +- `workflow` 工作流改进 +- `ci` 持续集成 +- `types` 类型定义文件更改 +- `wip` 开发中 + +### 提交校验 + +代码首次拉下来 `pnpm install` 后 需要执行以下命令来更新 `git hooks` + +```shell +# Update ./git/hooks +npx simple-git-hooks +``` + +本项目提交规范校验使用 [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) 作为 git hooks，使用 [cz-git](https://github.com/Zhengqbbb/cz-git) 作为 commitlint commitizen。 + +代码要想使用 commitlint 规范提交需要在更改的文件 `git add` 后，控制台执行 `cz` 命令开启 cz-git CLI + +若想直接执行 `git commit` 需要满足上面提交规范才能通过校验，否则无法提交 + +simple-git-hooks 和 husky 都是用于管理 Git 钩子（Git hooks）的工具，但它们有一些区别： + +1. simple-git-hooks: + +- 简介: simple-git-hooks 是一个轻量级的工具，用于管理和运行Git钩子。 +- 特点: + - 提供了简单的配置方式来定义和运行 Gi 钩子。 + - 适合于小型项目或对 Git 钩子需求不复杂的项目。 + - 相对较少的功能和配置选项。 + - 使用场景: 适用于简单的项目或对 Git 钩子管理需求不高的情况。 + +2. husky: + +- 简介: husky 是一个功能强大的工具，用于管理 Git 钩子，并且在项目中被广泛使用。 +- 特点: + - 提供了丰富的配置选项和灵活性，可以精细地控制 Git 钩子的行为。 + - 支持在不同的 Git 钩子事件上运行自定义脚本。 + - 可以与其他工具（如linters、测试框架等）集成，实现更复杂的工作流。 + - 使用场景: 适用于需要灵活配置和管理 Git 钩子的项目，尤其是大型或复杂的项目。 + +```json +// package.json +{ + "simple-git-hooks": { + // 对暂存区执行 eslint --fix + "pre-commit": "pnpm lint-staged", + // 对提交信息进行校验 + "commit-msg": "npx --no-install commitlint --edit $1" + }, + + "lint-staged": { + "*": "eslint --fix" + } +} +``` ## 浏览器支持 @@ -142,8 +195,8 @@ pnpm build 支持现代浏览器, 不支持 IE | [![ Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](http://godban.github.io/browsers-support-badges/) IE | [![ Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](http://godban.github.io/browsers-support-badges/) Edge | [![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](http://godban.github.io/browsers-support-badges/) Firefox | [![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](http://godban.github.io/browsers-support-badges/) Chrome | [![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)](http://godban.github.io/browsers-support-badges/) Safari | -| --- | --- | --- | --- | --- | -| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | ## 维护者