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
28613061
Commit
28613061
authored
Nov 11, 2019
by
郑其龙
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
feat(readme): 正式版v1.0说明文档发布
parent
507db0bd
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
5 deletions
+9
-5
README.md
+9
-5
No files found.
README.md
View file @
28613061
...
@@ -2,22 +2,22 @@
...
@@ -2,22 +2,22 @@
本文为介绍约定式提交,主要从以下几点展开:
本文为介绍约定式提交,主要从以下几点展开:
-
[
现状分析
](
)
-
[
约定式提交
](
)
-
[
约定式提交
](
)
-
[
优点
](
)
-
[
优点
](
)
-
[
规范
](
)
-
[
规范
](
)
-
[
commitizen
](
)
-
[
commitizen
](
)
-
[
standard-version
](
)
-
[
standard-version
](
)
# 现状分析
# 现状分析
目前我们的项目在commit时基本上五花八门,各领风骚。这一现象严重影响我们在阅读提交记录和查找bug原因时的效率。
目前我们的项目在commit时基本上五花八门,各领风骚。这一现象严重影响我们在阅读提交记录和查找bug原因时的效率。
我们可以感受下:
我们可以感受下:


...
@@ -31,7 +31,7 @@
...
@@ -31,7 +31,7 @@
>
为了提高开发效率,减少在处理问题时耗费的时间,推荐大家在写完代码,提交时能够使用以下规范:
>
**为了提高开发效率,减少在处理问题时耗费的时间,推荐大家在写完代码,提交时能够使用以下规范:**
-
规范化提交(不一定是文中提到的方式,但无论哪种方式,要做到
`统一`
、
`简明`
)
-
规范化提交(不一定是文中提到的方式,但无论哪种方式,要做到
`统一`
、
`简明`
)
-
一处变更一次commit(谨防多处、多次修改堆积成一次commit提交,这对后期bug分析将是灾难)
-
一处变更一次commit(谨防多处、多次修改堆积成一次commit提交,这对后期bug分析将是灾难)
...
@@ -114,6 +114,7 @@ ps: 对于`非Node项目`(java、php...)在执行上一条命令前,需要手动
...
@@ -114,6 +114,7 @@ ps: 对于`非Node项目`(java、php...)在执行上一条命令前,需要手动
> $ npm init --yes
> $ npm init --yes
> ```
> ```
通过如上命令生成
[
package.json
](
)文件基本格式如下:
```
json
```
json
{
{
...
@@ -159,4 +160,7 @@ ps: 对于`非Node项目`(java、php...)在执行上一条命令前,需要手动
...
@@ -159,4 +160,7 @@ ps: 对于`非Node项目`(java、php...)在执行上一条命令前,需要手动
> 生成CHANGELOG的工具很多,[conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)也可以用来生成CHANGELOG,安装使用方法和`standard-version`类似
> 生成CHANGELOG的工具很多,[conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)也可以用来生成CHANGELOG,安装使用方法和`standard-version`类似
# 总结
本项目的CHANGELOG生成实例:
[
CHANGELOG查看
](
https://git.senthink.com/zhengql/Conventional-Commits/blob/master/CHANGELOG.md
)
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