Peak-Vue3-Admin 是一个以 vue-admin-template 为基础框架升级,整合了各种后台项目的优点对移动端有一定的适配,并对项目整体进行了大量逻辑、结构、样式的重构和梳理,具备了一定规范的模块化开发,项目使用了 Vite3、Vue3、TypeScript、Pinia、Element-Plus 等目前最新技术栈开发,基于 mock 实现本地数据模拟具备规范接口请求,本项目对代码进行了大量的代码说明以及对样式的分析和注释,大大降低了开发和学习的成本,既可以学习又可以基于模板功能二次开发。
[^注意事项]: node 版本 16 以上
git clone https://gitee.com/Iontheroad/peak-vue3-admin.git
npm install
npm run dev
处于开发状态,预览项目请切换 dev_zgf
任务相关:
BUG: 用来标记 BUG 或者问题~
FIXME: 用来标记一些需要修复的位置,可以快速定位(已知的无法运行的代码)。
TODO: 用来标记待办的地方,当天没有完成第二天需要继续的任务。
NOTE: 添加一些说明文字。
TAG: 用来创建一些标记。
RESOLVED:已解决的 bug 等问题。
优化和改进相关:
HACK: 用来标记可能需要更改的地方。在写代码的时候,有的地方我们并不确定他是正确的,可能未来有所更改,这时候可以使用 HACK 标记。
XXX: 用来标记一些草率实现的地方。在写代码的时候,有些地方需要频繁修改,这时候使用 XXX 标记。
OPTIMIZE: 需要优化的代码或需要进一步优化的方案。
QUESTION: 标记需要回答的问题或需要进一步确认的事项。
IDEA: 代码中的新想法或新方案,需要进一步讨论或实现。
Git 提交规范可以使用以下格式:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
其中,<type>
和<subject>
是必填项,其他为可选项。
<type>
:提交的类型,建议使用以下类型之一:
feat
:新功能fix
:修复问题docs
:修改文档style
:修改代码格式,不影响代码逻辑refactor
:重构代码,既不修复问题也不添加新功能test
:添加或修改测试代码chore
:修改构建流程或辅助工具<scope>
:修改的范围,可以是文件名、模块名等等
<subject>
:简短描述修改的内容
<body>
:详细描述修改的内容,可以分多行
<footer>
:一些备注信息,例如关联的 issue 编号等
例如:
feat(login): 添加邮箱登录功能
添加了用户可以使用邮箱登录的功能,同时更新了登录页面的UI
Closes #123
这样的提交规范可以帮助团队更好地管理和维护代码库,提高代码质量和可读性。
在命令行中提交使用这种规范,可以先在本地仓库中进行修改和提交,然后使用以下命令进行提交:
git commit -m "<type>(<scope>): <subject>" -m "<body>" -m "<footer>"
其中,-m
选项表示提交信息中的一行,需要使用多次-m
选项来添加多行信息。
例如,我们使用以下命令提交一个新功能的修改:
git commit -m "feat(login): 添加邮箱登录功能" -m "添加了用户可以使用邮箱登录的功能,同时更新了登录页面的UI." -m "Closes #123"
这样就可以将修改提交到本地仓库中了。如果需要将修改推送到远程仓库,可以使用git push
命令。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。