doc: 增加 fork 配置提交模板文档

This commit is contained in:
Argo-PD 2020-03-27 12:51:16 +08:00
parent be7a2f80bd
commit 861dbee3b0
5 changed files with 89 additions and 0 deletions

View File

@ -121,6 +121,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Oracle", "Oracle", "{41E078
db\Oracle\Install.sql = db\Oracle\Install.sql db\Oracle\Install.sql = db\Oracle\Install.sql
EndProjectSection EndProjectSection
EndProject EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "git", "git", "{64EACBD1-23DD-4168-BEED-55D47DB1A8BB}"
ProjectSection(SolutionItems) = preProject
scripts\git\commit_msg_template.txt = scripts\git\commit_msg_template.txt
scripts\git\readme.md = scripts\git\readme.md
scripts\git\run.cmd = scripts\git\run.cmd
scripts\git\run.sh = scripts\git\run.sh
EndProjectSection
EndProject
Global Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU Debug|Any CPU = Debug|Any CPU
@ -179,6 +187,7 @@ Global
{5F732D4E-133B-4DA6-811B-C369CDC3FB89} = {72C103DB-E1D3-449F-97C2-DF12CA111FD4} {5F732D4E-133B-4DA6-811B-C369CDC3FB89} = {72C103DB-E1D3-449F-97C2-DF12CA111FD4}
{68F7C160-3FB2-4129-8F89-96F78B2DA0A9} = {FDCFC3E3-14CF-40B2-9FE5-5BC239AAC110} {68F7C160-3FB2-4129-8F89-96F78B2DA0A9} = {FDCFC3E3-14CF-40B2-9FE5-5BC239AAC110}
{41E078CA-F005-4B66-B440-FD7EB731AD61} = {586410F2-C1F0-47CD-AB28-2CF506DED2C8} {41E078CA-F005-4B66-B440-FD7EB731AD61} = {586410F2-C1F0-47CD-AB28-2CF506DED2C8}
{64EACBD1-23DD-4168-BEED-55D47DB1A8BB} = {72C103DB-E1D3-449F-97C2-DF12CA111FD4}
EndGlobalSection EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {221EAE38-5F75-4391-9A48-E462A9F3B8FC} SolutionGuid = {221EAE38-5F75-4391-9A48-E462A9F3B8FC}

View File

@ -0,0 +1,42 @@
fix(#BUGID): 简要描述
#Comment
comment #BUGID
#Issue
close link fix https://gitee.com/LongbowEnterprise/dashboard/issues?id=BUGID
# 样式 : feat(location): 接入登录API
#
# 登录功能与服务器对接
#
<type>(<scope>): <subject>
<body>
<footer>
#其中 type 的值可以有
# feat: 新功能
# fix: 修复bug
# doc: 文档改变
# style: 代码格式改变
# refactor: 某个已有功能重构
# perf: 性能优化
# test: 增加测试
# build: 改变了build工具 如 更新 props 文件
# revert: 撤销上一次的 commit
# db: 数据库文件或者脚本更改
# script: 辅助脚本改变
#
#scope: 用来说明此次修改的影响范围
# all: 表示影响面大 ,如修改了网络框架 会对真个程序产生影响
# location: 表示影响小,某个小小的功能
# module: 表示会影响某个模块 如登录模块、首页模块 、用户管理模块等等
#
#subject: 用来简要描述本次改动,概述就好了
#
#body: 具体的修改信息 应该尽量详细
#
#footer: 放置写备注啥的,如果是 bug 可以把bug id放入
#

32
scripts/git/readme.md Normal file
View File

@ -0,0 +1,32 @@
## 提交模板配置
### Windows Fork
Windows 版本的 Fork 提供了提交模板 commit message template功能配置步骤如下
#### git 配置文件
1. 拷贝仓库 `scripts\git\commit_msg_template.txt` 文件到当前用户根目录下 `C:\Users\[用户名]\.commit_msg_template.txt`
2. 配置 git 全局配置文件 `C:\Users\[用户名]\.gitconfig` (此文件为隐藏文件)
3. 更新 commit 配置项
```log
[commit]
template = /Users/argo/.commit_msg_template.txt
```
注意原始文件不是 . 开头拷贝到跟目录下为 . 开头文件名(点号开头文件默认为隐藏文件)
#### Fork 配置步骤
1. 打开要配置的仓库
2. 点击菜单栏第二个 **仓库** 菜单Repository
3. 下拉菜单中选中最后一个菜单项 **仓库设置** 子菜单Settings for this repository
如下图所示
![输入图片说明](https://images.gitee.com/uploads/images/2020/0327/123310_1b9b4af3_554725.png "Screen Shot 2020-03-27 at 12.30.38.png")
4. 切换到 **提交模板** 面板Commit Template
5. 勾选使用 **全局配置文件** Use global git configuration file
下面的文本框内即出现提交模板内容

3
scripts/git/run.cmd Normal file
View File

@ -0,0 +1,3 @@
@echo off
copy commit_msg_template.txt "%USERPROFILE%\.commit_msg_template.txt" /y

3
scripts/git/run.sh Normal file
View File

@ -0,0 +1,3 @@
#! /bin/bash
cp commit_msg_template.txt "../../.git/commit_msg_template1.txt"