From 974655f5da27fa4081cbf70499e632d9508f50fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anto=20Kein=C3=A4nen?= <62938747+antoKeinanen@users.noreply.github.com> Date: Wed, 10 May 2023 17:47:09 +0300 Subject: [PATCH] docs: include examples of commit header, itroduce issue id, and specify message body --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 19e0c67..e403f6b 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ All commit messages must conform to this format: ``` ## Commit Header -The type field is always required. A summary is optional when bumping the version. Every commit should only contain one type. +The type field is always required. A summary is optional when bumping the version. If the commit is related to issue please refer to it. Every commit should only contain one type. ``` -: +(): │ │ │ └─⫸ Summary in the present tense. Not capitalized. No period at the end. │ @@ -54,6 +54,7 @@ The type field is always required. A summary is optional when bumping the versio └─⫸ Commit Type: build|docs|feat|fix|perf|refactor|test ``` ### Type +**Example**: `fix(#123): fix a bug where XYZ`, `bump-version`, `feat(#123): add a feature that XYZ` Must be one of the following: - build: Changes that affect the build system or external dependencies - docs: Documentation only changes @@ -68,6 +69,11 @@ Use the summary field to provide a succinct description of the change: - don't capitalize the first letter - no dot (.) at the end +## Message body +- Optional but recommended +- Just as in use imperative, present tense: “change” not “changed” nor “changes” + + # Support You can support me by buying me a coffee at [buymeacoffee.com](https://www.buymeacoffee.com/antokeinanen)! \ No newline at end of file