Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Conventional-Commits
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
1
Issues
1
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
郑其龙
Conventional-Commits
Commits
5c1f2323
Commit
5c1f2323
authored
Nov 11, 2019
by
郑其龙
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fix(docs): 修复README排版问题
parent
75d5798e
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
40 additions
and
24 deletions
+40
-24
README.md
+40
-24
No files found.
README.md
View file @
5c1f2323
...
@@ -6,9 +6,39 @@
...
@@ -6,9 +6,39 @@
-
[
优点
](
)
-
[
优点
](
)
-
[
规范
](
)
-
[
规范
](
)
-
[
commitizen
](
)
-
[
commitizen
](
)
-
[
安装使用
](
)
-
[
standard-version
](
)
-
[
standard-version
](
)
-
[
安装使用
](
)
# 现状分析
目前我们的项目在commit时基本上五花八门,各领风骚。这一现象严重影响我们在阅读提交记录和查找bug原因时的效率。
我们可以感受下:

可对比看看同样后端项目
[
Nacos
]
的部分提交记录

其实已经越来越多的人开始意识到规范化提交的重要性,比如就在我们身边,QIQ的前端项目
`Sky`
提交记录

> 为了提高开发效率,减少在处理问题时耗费的时间,推荐大家在写完代码,提交时能够使用以下规范:
-
规范化提交(不一定是文中提到的方式,但无论哪种方式,要做到
`统一`
、
`简明`
)
-
一处变更一次commit(谨防多处、多次修改堆积成一次commit提交,这对后期bug分析将是灾难)
# 约定式提交
# 约定式提交
...
@@ -79,7 +109,11 @@
...
@@ -79,7 +109,11 @@
> ```
> ```
ps: 对于
`非Node项目`
(java、php...)在执行上一条命令前需要手动创建
[
package.json
](
)文件
ps: 对于
`非Node项目`
(java、php...)在执行上一条命令前,需要手动创建
[
package.json
](
)文件
> ```bash
> $ npm init --yes
> ```
```json
```json
{
{
...
@@ -120,26 +154,9 @@ ps: 对于`非Node项目`(java、php...)在执行上一条命令前需要手动
...
@@ -120,26 +154,9 @@ ps: 对于`非Node项目`(java、php...)在执行上一条命令前需要手动
> ```
> ```
# 总结
备注:
目前我们的项目在commit时基本上五花八门,各领风骚。这一现象严重影响我们在阅读提交记录和查找bug原因时的效率。
我们可以感受下:

可对比看看同样后端项目
[
Nacos
]
的部分提交记录

> 生成CHANGELOG的工具很多,[conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)也可以用来生成CHANGELOG,安装使用方法和`standard-version`类似
其实已经越来越多的人开始意识到规范化提交的重要性,比如就在我们身边,QIQ的前端项目
`Sky`
提交记录

# 总结
> 为了提高开发效率,减少在处理问题时耗费的时间,推荐大家在写完代码,提交时能够使用以下规范:
-
规范化提交(不一定是文中提到的方式,但无论哪种方式,要做到
`统一`
、
`简明`
)
-
一处变更一次commit(谨防多处、多次修改堆积成一次commit提交,这对后期bug分析将是灾难)
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment