Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/target
.commitlintrc.*
2 changes: 1 addition & 1 deletion web/src/content/docs/rules/scope-empty.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ docs(cli): fix typo

```yaml
rules:
type-empty:
scope-empty:
level: error
```
10 changes: 5 additions & 5 deletions web/src/content/docs/rules/scope-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]*$
```
6 changes: 3 additions & 3 deletions web/src/content/docs/rules/scope-max-length.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
4 changes: 2 additions & 2 deletions web/src/content/docs/rules/type-empty.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions web/src/content/docs/rules/type-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -34,5 +34,5 @@ feat(cli): Added a new flag
rules:
type-format:
level: error
format: ^[A-Z].*$
format: ^[a-z].*$
```
2 changes: 1 addition & 1 deletion web/src/content/docs/rules/type.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ fix(api): fix typo

```yaml
rules:
scope:
type:
level: error
options:
- api
Expand Down