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-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 ``` 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]*$ ``` 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 ``` 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 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].*$ ``` 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