From 0994ca3f6908e1c8554e6fe55e7eb44e017b195e Mon Sep 17 00:00:00 2001 From: KeisukeYamashita <19yamashita15@gmail.com> Date: Tue, 13 Feb 2024 17:35:13 +0100 Subject: [PATCH 1/6] fix(web): incorrect scope empty example Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com> --- web/src/content/docs/rules/scope-empty.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/src/content/docs/rules/scope-empty.md b/web/src/content/docs/rules/scope-empty.md index 1e74eba..9ed0c9c 100644 --- a/web/src/content/docs/rules/scope-empty.md +++ b/web/src/content/docs/rules/scope-empty.md @@ -23,6 +23,6 @@ docs(cli): fix typo ```yaml rules: - type-empty: + scope-empty: level: error ``` From cf5552883af828ebe6183e2cc640b4162a0a0c06 Mon Sep 17 00:00:00 2001 From: KeisukeYamashita <19yamashita15@gmail.com> Date: Tue, 13 Feb 2024 17:37:05 +0100 Subject: [PATCH 2/6] fix(web): example fo the scope Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com> --- web/src/content/docs/rules/type.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/src/content/docs/rules/type.md b/web/src/content/docs/rules/type.md index 0f83527..ff96daf 100644 --- a/web/src/content/docs/rules/type.md +++ b/web/src/content/docs/rules/type.md @@ -35,7 +35,7 @@ fix(api): fix typo ```yaml rules: - scope: + type: level: error options: - api From de5a49bbe660072b2a6ce5254596be87dcc9c1fe Mon Sep 17 00:00:00 2001 From: KeisukeYamashita <19yamashita15@gmail.com> Date: Tue, 13 Feb 2024 17:38:19 +0100 Subject: [PATCH 3/6] fix(web): type empty wrong example Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com> --- web/src/content/docs/rules/type-empty.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/src/content/docs/rules/type-empty.md b/web/src/content/docs/rules/type-empty.md index 44f1caa..28a9db8 100644 --- a/web/src/content/docs/rules/type-empty.md +++ b/web/src/content/docs/rules/type-empty.md @@ -12,13 +12,13 @@ docs: fix typo ``` ```console -docs(): fix typo +(web): fix typo ``` ## ✅ Good ```console -docs(scope): fix typo +docs(web): fix typo ``` ## Example From b927e126b454d36b262966ebf9188a37d1fc4613 Mon Sep 17 00:00:00 2001 From: KeisukeYamashita <19yamashita15@gmail.com> Date: Tue, 13 Feb 2024 17:42:37 +0100 Subject: [PATCH 4/6] fix(web): example of the scope format Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com> --- .gitignore | 1 + web/src/content/docs/rules/scope-format.md | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index ea8c4bf..d8fa3e3 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /target +.commitlintrc.* diff --git a/web/src/content/docs/rules/scope-format.md b/web/src/content/docs/rules/scope-format.md index 701fe43..d15bba4 100644 --- a/web/src/content/docs/rules/scope-format.md +++ b/web/src/content/docs/rules/scope-format.md @@ -11,28 +11,28 @@ In this page, we will use the following commit message as an example. rules: scope-format: level: error - format: ^[A-Z].*$ + format: ^[a-z]*$ ``` ## ❌ Bad ```console -feat(cli): added a new flag +feat(Cli): added a new flag ``` ## ✅ Good ```console -feat(cli): Added a new flag +feat(cli): added a new flag ``` ## Example -### Scope must start with a capital letter +### Scope must start with a lower letter ```yaml rules: scope-format: level: error - format: ^[A-Z].*$ + format: ^[a-z]*$ ``` From f571b5ce56d07ace198a45bf08edacf2d352d907 Mon Sep 17 00:00:00 2001 From: KeisukeYamashita <19yamashita15@gmail.com> Date: Tue, 13 Feb 2024 17:59:22 +0100 Subject: [PATCH 5/6] fix(web): type format wrong example Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com> --- web/src/content/docs/rules/type-format.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/src/content/docs/rules/type-format.md b/web/src/content/docs/rules/type-format.md index 43b6d8e..ee9c0d1 100644 --- a/web/src/content/docs/rules/type-format.md +++ b/web/src/content/docs/rules/type-format.md @@ -11,13 +11,13 @@ In this page, we will use the following commit message as an example. rules: type-format: level: error - format: ^[A-Z].*$ + format: ^[a-z].*$ ``` ## ❌ Bad ```console -feat(cli): added a new flag +Feat(cli): added a new flag ``` ## ✅ Good @@ -34,5 +34,5 @@ feat(cli): Added a new flag rules: type-format: level: error - format: ^[A-Z].*$ + format: ^[a-z].*$ ``` From f2f8ba63047afe7f6d37648c2efade81880ef546 Mon Sep 17 00:00:00 2001 From: KeisukeYamashita <19yamashita15@gmail.com> Date: Tue, 13 Feb 2024 18:02:22 +0100 Subject: [PATCH 6/6] fix(web): example of scope max length Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com> --- web/src/content/docs/rules/scope-max-length.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/src/content/docs/rules/scope-max-length.md b/web/src/content/docs/rules/scope-max-length.md index 6dc18be..aeba203 100644 --- a/web/src/content/docs/rules/scope-max-length.md +++ b/web/src/content/docs/rules/scope-max-length.md @@ -12,7 +12,7 @@ In this page, we will use the following commit message as an example. rules: scope-max-length: level: error - length: 6 + length: 5 ``` ## ❌ Bad @@ -29,11 +29,11 @@ feat(cli): add new flag ## Example -### Description length should be less than or equal to 72 +### Description length should be less than or equal to 5 ```yaml rules: scope-max-length: level: error - length: 72 + length: 5 ```