Sfoglia il codice sorgente

doc: 修改项目README,将Git规范移至GitConvention.md。增加作业要求的说明。

kenny67nju 6 anni fa
parent
commit
d837f9733e
2 ha cambiato i file con 59 aggiunte e 43 eliminazioni
  1. 54 0
      GitConvention.md
  2. 5 43
      README.md

+ 54 - 0
GitConvention.md

@@ -0,0 +1,54 @@
+# Git规范
+
+## Branch规范
+
+分支的命名限定在以下范围(master | dev | develop | release | feature/xxx | hotfix/xxx | fix/xxx ) xxx为任意内容
+
+Eg. 1.feature/酒店信息管理    2.hotfix/订单流程更改 
+
+## Commit规范
+
+每次commit时,添加的描述信息需要有一个特定的前缀,限定在以下范围(feat|doc|test|docs|chore|refactor|fix|style| perf): xxx    **注意冒号后面有一个空格**
+
+feat - 新功能(feature)
+
+doc- 文档(documentation)
+
+style- 格式(不影响代码运行的变动)
+
+refactor- 重构(即不是新增功能,也不是修改bug的代码变动)
+
+fix- 修补bug
+
+test- 增加测试
+
+chore- 构建过程或辅助工具的变动
+
+Eg. 1.feat: 查看酒店信息功能完成  2.fix: 浏览酒店bug修复
+
+以上限定是为了帮助同学们尽早熟悉GitFlow开发模式,关于GitFlow的更多信息,可以参考以下链接或自行谷歌百度
+
+[https://github.com/xirong/my-git/blob/master/git-workflow-tutorial.md#23-gitflow%E5%B7%A5%E4%BD%9C%E6%B5%81](https://github.com/xirong/my-git/blob/master/git-workflow-tutorial.md#23-gitflow工作流)
+
+http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
+
+
+
+## 开发流程
+
+只有release分支可以进行Test环境部署,clone项目之后新建release分支
+
+~~~bash
+git checkout -b release
+git add .
+git commit -m 'feat: xxx'
+git push --set-upstream origin release
+~~~
+
+只有master分支可以进行Prod环境部署。
+
+~~~bash
+git checkout -b master
+git merge release
+git push origin master
+~~~

+ 5 - 43
README.md

@@ -1,47 +1,9 @@
 # 酒店管理系统
 
+## 作业说明
+  1. 学习前后端环境搭建,包括Vue,springboot,mysql等。
+  2. 学习本地运行项目,了解本地开发、测试流程。
+  3. 学习git操作,提交项目至SEEC的gitlab代码库,查看构建、部署、测试结果。
+  4. 学习前后端开发技术。
 
 
-## Git规范
-
-分支的命名限定在以下范围(master | dev | develop | release | feature/xxx | hotfix/xxx | fix/xxx ) xxx为任意内容
-
-Eg. 1.feature/酒店信息管理    2.hotfix/订单流程更改 
-
-每次commit时,添加的描述信息需要有一个特定的前缀,限定在以下范围(feat|doc|test|docs|chore|refactor|fix|style| perf): xxx    **注意冒号后面有一个空格**
-
-feat - 新功能(feature)
-
-doc- 文档(documentation)
-
-style- 格式(不影响代码运行的变动)
-
-refactor- 重构(即不是新增功能,也不是修改bug的代码变动)
-
-fix- 修补bug
-
-test- 增加测试
-
-chore- 构建过程或辅助工具的变动
-
-Eg. 1.feat: 查看酒店信息功能完成  2.fix: 浏览酒店bug修复
-
-以上限定是为了帮助同学们尽早熟悉GitFlow开发模式,关于GitFlow的更多信息,可以参考以下链接或自行谷歌百度
-
-[https://github.com/xirong/my-git/blob/master/git-workflow-tutorial.md#23-gitflow%E5%B7%A5%E4%BD%9C%E6%B5%81](https://github.com/xirong/my-git/blob/master/git-workflow-tutorial.md#23-gitflow工作流)
-
-http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
-
-
-
-### 开发规范
-
-只有release分支可以进行Test环境部署,clone项目之后新建release分支
-
-~~~bash
-git checkout -b release
-git add .
-git commit -m 'feat: xxx'
-git push --set-upstream origin release
-~~~
-