Commit 5c1f2323 by 郑其龙

fix(docs): 修复README排版问题

parent 75d5798e
......@@ -6,9 +6,39 @@
- [优点]()
- [规范]()
- [commitizen]()
- [安装使用]()
- [standard-version]()
- [安装使用]()
# 现状分析
目前我们的项目在commit时基本上五花八门,各领风骚。这一现象严重影响我们在阅读提交记录和查找bug原因时的效率。
我们可以感受下:
![discovery提交记录截图](/img/discovery-commit.png)
可对比看看同样后端项目[Nacos]的部分提交记录
![nacos提交记录截图](/img/nacos-commit.png)
其实已经越来越多的人开始意识到规范化提交的重要性,比如就在我们身边,QIQ的前端项目`Sky`提交记录
![qiq-sky提交记录截图](/img/sky-commit.png)
> 为了提高开发效率,减少在处理问题时耗费的时间,推荐大家在写完代码,提交时能够使用以下规范:
- 规范化提交(不一定是文中提到的方式,但无论哪种方式,要做到`统一`、`简明`)
- 一处变更一次commit(谨防多处、多次修改堆积成一次commit提交,这对后期bug分析将是灾难)
# 约定式提交
......@@ -79,7 +109,11 @@
> ```
ps: 对于`非Node项目`(java、php...)在执行上一条命令前需要手动创建[package.json]()文件
ps: 对于`非Node项目`(java、php...)在执行上一条命令前,需要手动创建[package.json]()文件
> ```bash
> $ npm init --yes
> ```
```json
{
......@@ -120,26 +154,9 @@ ps: 对于`非Node项目`(java、php...)在执行上一条命令前需要手动
> ```
# 总结
目前我们的项目在commit时基本上五花八门,各领风骚。这一现象严重影响我们在阅读提交记录和查找bug原因时的效率。
备注:
我们可以感受下:
> 生成CHANGELOG的工具很多,[conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)也可以用来生成CHANGELOG,安装使用方法和`standard-version`类似
![discovery提交记录截图](/img/discovery-commit.png)
可对比看看同样后端项目[Nacos]的部分提交记录
![nacos提交记录截图](/img/nacos-commit.png)
其实已经越来越多的人开始意识到规范化提交的重要性,比如就在我们身边,QIQ的前端项目`Sky`提交记录
![qiq-sky提交记录截图](/img/sky-commit.png)
> 为了提高开发效率,减少在处理问题时耗费的时间,推荐大家在写完代码,提交时能够使用以下规范:
- 规范化提交(不一定是文中提到的方式,但无论哪种方式,要做到`统一`、`简明`)
- 一处变更一次commit(谨防多处、多次修改堆积成一次commit提交,这对后期bug分析将是灾难)
\ No newline at end of file
# 总结
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment