From 88452653515f2dd20d6f81417b82b39db1ef63ed Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Mon, 26 Jun 2023 23:53:24 +1000 Subject: [PATCH] feat: apply Conventional Commits --- README.md | 70 ++++++++++++++++++++++++++++++ scripts/commit-msg | 35 +++++++++++++++ scripts/drupal/install-new-site.sh | 3 ++ 3 files changed, 108 insertions(+) create mode 100755 scripts/commit-msg diff --git a/README.md b/README.md index 4999734..ae7ddd1 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,76 @@ Finally, we install the module itself. 1.2.3-alpha.1.2 ``` +## Conventional Commits +Benefits of Conventional Commits +1. Each commit message provides additional relevant information, making it easier to browse through the commit history quickly. +2. It allows for easy filtering of commits using git log --grep , enabling fast searching for specific information. +3. Commit messages can be used to generate a Change log directly, summarizing the changes made in the project. + +#### Conventional Commits consist of three parts: Header, Body, and Footer. The format is as follows: + +```shell +(): + + + +