Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Perfect readme #11

Merged
merged 4 commits into from
May 31, 2021
Merged

[WIP] Perfect readme #11

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2e39b0
[Add::doc] add chinese document
z825316969 May 31, 2021
20a235c
[Update] commit type add Doc Perf and delete New in config readme
z825316969 May 31, 2021
1b7b2f7
[Update::readme] update type description
z825316969 May 31, 2021
cce50ce
[Fix::readme] update type description
z825316969 May 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ The commit message should consists of four parts:
- Update
- Refactor
- Move
- New
- Perf
- Doc
- Add
- Patch
- Fix
Expand Down
3 changes: 2 additions & 1 deletion doc/README-zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ git 的`commit-message`由以下四部分组成：
| Update | 对原有功能的修改 |
| Refactor | 代码重构 |
| Move | 移动文件位置 |
| New | 规模较大的新增 |
| Perf | 优化相关，比如提升性能、体验 |
| Doc | 修改了文档，比如 README |
| Add | 规模较小的新增 |
| Patch | 对公共方法的完善或者优化 |
| Fix | 修复 bug |
Expand Down
3 changes: 2 additions & 1 deletion packages/commitlint-config-wizardoc/src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ export enum CommitType {
UPDATE = "Update",
REFACTOR = "Refactor",
MOVE = "Move",
NEW = "New",
ADD = "Add",
PATCH = "Patch",
FIX = "Fix",
TEST = "Test",
STUB = "Stub",
CHORE = "Chore",
PERF = "Perf",
DOC = "Doc",
}

export const CONVERSION_MATCH_REGEX = /^(.?)\[(\w+?)(?:\:\:(\w*))?\]\s(.*)$/;