You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Lint commit messages against your conventional-changelog preset
1
+
> Lint commit messages
2
2
3
-
<palign="center">
4
-
<h1>conventional-changelog-lint</h1>
5
-
</p>
3
+
# commitlint
6
4
7
-
Yeay! You want to contribute to conventional-changelog-lint. That's amazing!
5
+
Yeay! You want to contribute to commitlint. That's amazing!
8
6
To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.
9
7
10
8
## Found an Issue?
11
-
Thank you for reporting any issues you find. We do our best to test and make conventional-changelog-lint as solid as possible, but any reported issue is a real help.
9
+
Thank you for reporting any issues you find. We do our best to test and make commitlint as solid as possible, but any reported issue is a real help.
12
10
13
-
> conventional-changelog-lint issues
11
+
> commitlint issues
14
12
15
13
Please follow these guidelines when reporting issues:
16
14
* Provide a title in the format of `<Error> when <Task>`
17
15
* Tag your issue with the tag `bug`
18
16
* Provide a short summary of what you are trying to do
19
17
* Provide the log of the encountered error if applicable
20
-
* Provide the exact version of conventional-changelog-lint. Check `npm ls conventional-changelog-lint` when in doubt
18
+
* Provide the exact version of commitlint. Check `npm ls @commitlint/cli` when in doubt
21
19
* Be awesome and consider contributing a [pull request](#want-to-contribute)
22
20
23
21
## Want to contribute?
24
-
You consider contributing changes to conventional-changelog-lint – we dig that!
22
+
You consider contributing changes to commitlint – we dig that!
25
23
Please consider these guidelines when filing a pull request:
26
24
27
-
> conventional-changelog-lint pull requests
25
+
> commitlint pull requests
28
26
29
27
* Follow the [Coding Rules](#coding-rules)
30
28
* Follow the [Commit Rules](#commit-rules)
@@ -38,28 +36,22 @@ Please consider these guidelines when filing a pull request:
38
36
* What you removed
39
37
40
38
## Coding Rules
41
-
To keep the code base of conventional-changelog-lint neat and tidy the following rules apply to every change
39
+
To keep the code base of commitlint neat and tidy the following rules apply to every change
42
40
43
41
> Coding standards
44
42
45
-
*[Happiness](/sindresorhus/xo) enforced via eslint
43
+
*[Happiness](/sindresorhus/xo) enforced
46
44
* Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
47
-
* Coverage never drops below 90%
48
-
* No change may lower coverage by more than 5%
49
45
* Be awesome
50
46
51
47
## Commit Rules
52
-
To help everyone with understanding the commit history of conventional-changelog-lint the following commit rules are enforced.
53
-
To make your life easier conventional-changelog-lint is commitizen-friendly and provides the npm run-script `commit`.
48
+
To help everyone with understanding the commit history of commitlint the following commit rules are enforced.
49
+
To make your life easier commitlint is commitizen-friendly and provides the npm run-script `commit`.
Copyright 2016 by [Mario Nebl](https://github.com/marionebl) and [contributors](./graphs/contributors). Released under the [MIT license]('./license.md').
0 commit comments