We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent cea4564 commit 85a660dCopy full SHA for 85a660d
docs/_sidebar.md
@@ -13,3 +13,4 @@
13
* [Configuration](reference-configuration.md)
14
* [Rules](reference-rules.md)
15
* [API](reference-api.md)
16
+ * [Examples](reference-examples.md)
docs/reference-examples.md
@@ -0,0 +1,23 @@
1
+# Examples
2
+
3
+These examples show common usages of how commitlint can be configured.
4
5
6
+## Validate for issue/ticket numbers
7
8
+In your `package.json` add:
9
10
+```js
11
+ commitlint: {
12
+ 'rules': {
+ 'references-empty': [2, 'never'],
+ },
+ parserPreset: {
+ parserOpts: {
17
+ issuePrefixes: ['PROJ-']
18
+ }
19
20
21
+```
22
23
0 commit comments