Skip to content

Commit 7b96af5

Browse files
committed
docs: => commitlint
1 parent a2798d3 commit 7b96af5

File tree

1 file changed

+13
-21
lines changed

1 file changed

+13
-21
lines changed

Diff for: contributing.md

+13-21
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,28 @@
1-
> Lint commit messages against your conventional-changelog preset
1+
> Lint commit messages
22
3-
<p align="center">
4-
<h1>conventional-changelog-lint</h1>
5-
</p>
3+
# commitlint
64

7-
Yeay! You want to contribute to conventional-changelog-lint. That's amazing!
5+
Yeay! You want to contribute to commitlint. That's amazing!
86
To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.
97

108
## 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.
1210

13-
> conventional-changelog-lint issues
11+
> commitlint issues
1412
1513
Please follow these guidelines when reporting issues:
1614
* Provide a title in the format of `<Error> when <Task>`
1715
* Tag your issue with the tag `bug`
1816
* Provide a short summary of what you are trying to do
1917
* 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
2119
* Be awesome and consider contributing a [pull request](#want-to-contribute)
2220

2321
## 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!
2523
Please consider these guidelines when filing a pull request:
2624

27-
> conventional-changelog-lint pull requests
25+
> commitlint pull requests
2826
2927
* Follow the [Coding Rules](#coding-rules)
3028
* Follow the [Commit Rules](#commit-rules)
@@ -38,28 +36,22 @@ Please consider these guidelines when filing a pull request:
3836
* What you removed
3937

4038
## 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
4240

4341
> Coding standards
4442
45-
* [Happiness](/sindresorhus/xo) enforced via eslint
43+
* [Happiness](/sindresorhus/xo) enforced
4644
* 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%
4945
* Be awesome
5046

5147
## 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`.
5450

5551
> Commit standards
5652
57-
* [conventional-changelog](/commitizen/cz-conventional-changelog)
53+
* [conventional-changelog](./@commitlint/prompt)
5854
* husky commit message hook available
5955
* present tense
6056
* maximum of 100 characters
6157
* message format of `$type($scope): $message`
62-
63-
64-
---
65-
Copyright 2016 by [Mario Nebl](https://github.com/marionebl) and [contributors](./graphs/contributors). Released under the [MIT license]('./license.md').

0 commit comments

Comments
 (0)