Skip to content

Commit

Permalink
chore: add cz-conventional-changelog cli & update contributing guides (
Browse files Browse the repository at this point in the history
…#5148)

* chore: add commitizen cli

added cz-conventional-changelog to make commiting easier with the new linter

* docs: add commiting information to CONTRIBUTING.md

Added information on how to commit to the codebase via conventional commits
  • Loading branch information
bdbch committed May 14, 2024
1 parent d70e8a7 commit cdc147a
Show file tree
Hide file tree
Showing 3 changed files with 249 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ Before submitting a pull request:
- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

Before commiting:

- Make sure to run the tests and linter before committing your changes.
- Write [conventional commit messages](https://www.conventionalcommits.org/en). You can use `npm run cz` for that.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.
Expand Down
236 changes: 236 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"not IE 11"
],
"scripts": {
"cz": "cz",
"start": "npm --prefix ./demos run start",
"dev": "npm run start",
"lint": "eslint --cache --quiet --no-error-on-unmatched-pattern ./",
Expand Down Expand Up @@ -59,6 +60,7 @@
"@typescript-eslint/parser": "^5.10.2",
"babel-loader": "^8.2.3",
"cypress": "^10.8.0",
"cz-conventional-changelog": "^3.3.0",
"eslint": "^8.17.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-plugin-cypress": "^2.12.1",
Expand All @@ -79,5 +81,10 @@
"typescript": "^4.5.5",
"webpack": "^5.68.0"
},
"name": "tiptap"
"name": "tiptap",
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
}
}

0 comments on commit cdc147a

Please sign in to comment.