Skip to content

Commit

Permalink
feat(commit-msg): update commit message guidelines
Browse files Browse the repository at this point in the history
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
  • Loading branch information
phodal committed Jan 23, 2024
1 parent f0085a3 commit 9e1cc3b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
2 changes: 2 additions & 0 deletions settings.gradle.kts
Expand Up @@ -21,4 +21,6 @@ include(
"exts:database",
"exts:vue",
"exts:android",
// todo split vcs
// "exts:vcs",
)
20 changes: 11 additions & 9 deletions src/main/resources/genius/practises/gen-commit-msg.vm
@@ -1,20 +1,22 @@
Write a cohesive yet descriptive commit message for a given diff.
Make sure to include both information What was changed and Why.
Start with a short sentence in imperative form, no more than 50 characters long.
Then leave an empty line and continue with a more detailed explanation, if necessary.
Explanation should have less than 200 characters.
- Make sure to include both information What was changed and Why.
- Start with a short sentence in imperative form, no more than 50 characters long.
- Then leave an empty line and continue with a more detailed explanation, if necessary.
- Explanation should have less than 200 characters.

examples:
- fix(authentication): add password regex pattern
- feat(storage): add new test cases
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

Diff:
#if( $context.historyExamples.length() > 0 )
History Examples:
Here is History Examples:
$context.historyExamples
#end

Diff:

```diff
${context.diffContent}
```
Expand Down

0 comments on commit 9e1cc3b

Please sign in to comment.