Skip to content

Commit 9e1cc3b

Browse files
committed
feat(commit-msg): update commit message guidelines
Follow the Conventional Commits specification, examples: - fix(authentication): fix password regex pattern case - feat(storage): add support for S3 storage - test(java): fix test case for user controller - docs(docs): add architecture diagram to home page
1 parent f0085a3 commit 9e1cc3b

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

settings.gradle.kts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,6 @@ include(
2121
"exts:database",
2222
"exts:vue",
2323
"exts:android",
24+
// todo split vcs
25+
// "exts:vcs",
2426
)

src/main/resources/genius/practises/gen-commit-msg.vm

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
Write a cohesive yet descriptive commit message for a given diff.
2-
Make sure to include both information What was changed and Why.
3-
Start with a short sentence in imperative form, no more than 50 characters long.
4-
Then leave an empty line and continue with a more detailed explanation, if necessary.
5-
Explanation should have less than 200 characters.
2+
- Make sure to include both information What was changed and Why.
3+
- Start with a short sentence in imperative form, no more than 50 characters long.
4+
- Then leave an empty line and continue with a more detailed explanation, if necessary.
5+
- Explanation should have less than 200 characters.
66

7-
examples:
8-
- fix(authentication): add password regex pattern
9-
- feat(storage): add new test cases
7+
Follow the Conventional Commits specification, examples:
8+
- fix(authentication): fix password regex pattern case
9+
- feat(storage): add support for S3 storage
1010
- test(java): fix test case for user controller
11+
- docs(docs): add architecture diagram to home page
1112

12-
Diff:
1313
#if( $context.historyExamples.length() > 0 )
14-
History Examples:
14+
Here is History Examples:
1515
$context.historyExamples
1616
#end
1717

18+
Diff:
19+
1820
```diff
1921
${context.diffContent}
2022
```

0 commit comments

Comments
 (0)