Skip to content

Commit 2ff573e

Browse files
committed
docs(readme): add list of known adapters
We've got great contributors to the commitizen community. Let's give them the credit they deserve. Closes #34
1 parent 57284ec commit 2ff573e

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,17 @@ Your badge will look like this:
6464

6565
It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.
6666

67+
### Adapters
68+
69+
We know that every project and build process has different requirements so we've tried to keep Commitizen open for extension. You can do this by choosing from any of the pre-build adapters or even by building your own. Here are some of the great adapters available to you:
70+
71+
- [cz-conventional-changelog](https://www.npmjs.com/package/cz-conventional-changelog)
72+
- [cz-jira-smart-commit](https://www.npmjs.com/package/cz-jira-smart-commit)
73+
- [rb-conventional-changelog](https://www.npmjs.com/package/rb-conventional-changelog)
74+
- [cz-mapbox-changelog](https://www.npmjs.com/package/cz-mapbox-changelog)
75+
76+
To create an adapter, just fork one of these great adapters and modify it to suit your needs. We pass you an instance of [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/) but you can capture input using whatever means neccesary. Just call the `commit` callback with a string and we'll be happy. Publish it to npm, and you'll be all set!
77+
6778
### Philosophy
6879

6980
#### About Commitizen
@@ -72,7 +83,7 @@ Commitizen is an open source project that helps contributors be good open source
7283
#### Commitizen or Commit Hooks
7384
Both! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.
7485

75-
We accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.
86+
We accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-changlog adapter.
7687

7788
### Authors and Contributors
7889
@JimTheDev (Jim Cummins, author)

0 commit comments

Comments
 (0)