Skip to content

Commit ce6e4b4

Browse files
authored
Merge pull request #114 from datacrafts-io/feature/conventional-commits
Feature/conventional commits
2 parents 017fc4c + b4f89d7 commit ce6e4b4

File tree

4 files changed

+686
-4
lines changed

4 files changed

+686
-4
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
### _Very_ opinionated starter for Gatsby
3838

39-
This is a complex boilerplate for [Gatsby](https://www.gatsbyjs.org/).
39+
This is a complex boilerplate for [Gatsby](https://www.gatsbyjs.org/) with conventional commits.
4040

4141
Supports:
4242

@@ -50,6 +50,8 @@ Supports:
5050
- [testing-library](https://testing-library.com/)
5151
- [stylelint](https://stylelint.io/)
5252
- [ESLint](https://eslint.org/)
53+
- [commitizen](https://github.com/commitizen/cz-cli)
54+
- [commitlint](https://github.com/conventional-changelog/commitlint)
5355
- [Airbnb ESLint config](https://github.com/airbnb/javascript)
5456
- [Prettier support for ESLint](https://github.com/prettier/eslint-plugin-prettier)
5557
- [remark-lint](https://remark.js.org/)
@@ -87,6 +89,10 @@ Supports:
8789
$ npm run start
8890
```
8991

92+
1. **Committing.**
93+
94+
In order to commit in a conventional style conveniently you may run `npm run commit`.
95+
9096
## 🎓 Learning Gatsby
9197

9298
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:

commitlint.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {extends: ['@commitlint/config-conventional']};

0 commit comments

Comments
 (0)