Skip to content

Commit a6bafa9

Browse files
committed
docs: add multiple scope support info #701
1 parent d14f204 commit a6bafa9

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ commitlint checks if your commit messages meet the [conventional commit format](
4343
In general the pattern mostly looks like this:
4444

4545
```sh
46-
type(scope?): subject #scope is optional
46+
type(scope?): subject #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
4747
```
4848

4949
Real world examples can look like this:

docs/concepts-commit-conventions.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Concept: Commit conventions
22

3-
Commit conventions allow your team to add more semantic meaning to your git history. This e.g. includes `type`, `scope` or `breaking changes`.
3+
[Commit conventions](https://www.conventionalcommits.org/) allow your team to add more semantic meaning to your git history. This e.g. includes `type`, `scope` or `breaking changes`.
44

55
With this additional information tools can derive useful human-readable information for releases of your project. Some examples are
66

@@ -15,3 +15,12 @@ type(scope?): subject
1515
body?
1616
footer?
1717
```
18+
19+
## Multiple scopes
20+
21+
Commitlint supports multiple scopes.
22+
Current delimiter options are:
23+
24+
- "/"
25+
- "\"
26+
- ","

0 commit comments

Comments
 (0)