Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: replace all website references with conventional changelog #563

Merged
merged 2 commits into from
Jan 31, 2019
Merged
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
4 changes: 2 additions & 2 deletions @commitlint/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
> Lint commit messages
<p align="center">
<img width="750" src="https://marionebl.github.io/commitlint/assets/commitlint.svg">
<img width="750" src="https://conventional-changelog.github.io/assets/commitlint.svg">
</p>

# @commitlint/cli
@@ -13,4 +13,4 @@ npm install --save-dev @commitlint/cli @commitlint/config-angular
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
```

Consult [docs/cli](http://marionebl.github.io/commitlint/#/reference-cli) for comprehensive documentation.
Consult [docs/cli](https://conventional-changelog.github.io/#/reference-cli) for comprehensive documentation.
2 changes: 1 addition & 1 deletion @commitlint/config-angular/README.md
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.
### Problems

The following rules are considered problems for `@commitlint/config-angular` and will yield a non-zero exit code when not met.
Consult [docs/rules](http://marionebl.github.io/commitlint/#/reference-rules) for a list of available rules.
Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules.


#### type-enum
2 changes: 1 addition & 1 deletion @commitlint/config-conventional/README.md
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commit

The following rules are considered problems for `@commitlint/config-conventional` and will yield a non-zero exit code when not met.

Consult [docs/rules](https://marionebl.github.io/commitlint/#/reference-rules) for a list of available rules.
Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules.


#### type-enum
2 changes: 1 addition & 1 deletion @commitlint/config-lerna-scopes/readme.md
Original file line number Diff line number Diff line change
@@ -40,4 +40,4 @@ packages
✔ found 0 problems, 0 warnings
```

Consult [docs/rules](http://marionebl.github.io/commitlint/#/reference-rules) for a list of available rules.
Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules.
2 changes: 1 addition & 1 deletion @commitlint/config-patternplate/README.md
Original file line number Diff line number Diff line change
@@ -22,4 +22,4 @@ The following rules are considered problems for `@commitlint/config-patterplate`
* **rule**: `always`
* **value**: determined based on pattern tree. `system` and all pattern ids present in `patterns` are allowed

Consult [docs/rules](http://marionebl.github.io/commitlint/#/reference-rules) for a list of available rules.
Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules.
2 changes: 1 addition & 1 deletion @commitlint/format/README.md
Original file line number Diff line number Diff line change
@@ -59,5 +59,5 @@ process.stdout.write(output);
] */
```

Consult [docs/api](http://marionebl.github.io/commitlint/#/reference-api) for comprehensive documentation.
Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation.

2 changes: 1 addition & 1 deletion @commitlint/lint/README.md
Original file line number Diff line number Diff line change
@@ -30,4 +30,4 @@ lint('foo: bar', {'type-enum': [1, 'always', ['bar']]})
*/
```

Consult [docs/api](http://marionebl.github.io/commitlint/#/reference-api) for comprehensive documentation.
Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation.
2 changes: 1 addition & 1 deletion @commitlint/load/README.md
Original file line number Diff line number Diff line change
@@ -18,4 +18,4 @@ load({extends: ['./package']})
// => { extends: ['./package', './package-b'], rules: {} }
```

Consult [docs/api](http://marionebl.github.io/commitlint/#/reference-api) for comprehensive documentation.
Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation.
2 changes: 1 addition & 1 deletion @commitlint/prompt-cli/README.md
Original file line number Diff line number Diff line change
@@ -14,4 +14,4 @@ git add .
commit
```

A full usage guide is available at [docs/prompt](http://marionebl.github.io/commitlint/#/guides-use-prompt).
A full usage guide is available at [docs/prompt](https://conventional-changelog.github.io/#/guides-use-prompt).
2 changes: 1 addition & 1 deletion @commitlint/prompt/README.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@

This is the library and commitizen adapter version of commitlint prompt.
A ready-to-use cli version is available at [@commitlint/prompt-cli](../prompt-cli).
Learn how to use it at [docs/prompt](http://marionebl.github.io/commitlint/#/guides-use-prompt).
Learn how to use it at [docs/prompt](https://conventional-changelog.github.io/#/guides-use-prompt).

## Getting started

2 changes: 1 addition & 1 deletion @commitlint/read/README.md
Original file line number Diff line number Diff line change
@@ -24,4 +24,4 @@ read({from: 'HEAD~2', to: 'HEAD~1'})
// => ['Initial commit\n\n']
```

Consult [docs/api](http://marionebl.github.io/commitlint/#/reference-api) for comprehensive documentation.
Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Get Started](https://marionebl.github.io/commitlint/#/?id=getting-started) | [Let's chat][12] ![slack][11] | [Website](https://marionebl.github.io/commitlint)
# [Get Started](https://conventional-changelog.github.io/#/?id=getting-started) | [Let's chat][12] ![slack][11] | [Website](https://conventional-changelog.github.io)

> Lint commit messages
@@ -101,8 +101,8 @@ To lint commits before they are created you can use Husky's 'commit-msg' hook:

**Detailed Setup instructions**

* [Local setup](https://marionebl.github.io/commitlint/#/guides-local-setup) - Lint messages on commit with husky
* [CI setup](https://marionebl.github.io/commitlint/#/guides-ci-setup) - Lint messages during CI builds
* [Local setup](https://conventional-changelog.github.io/#/guides-local-setup) - Lint messages on commit with husky
* [CI setup](https://conventional-changelog.github.io/#/guides-ci-setup) - Lint messages during CI builds


## CLI