diff --git a/.commitlintrc.json b/.commitlintrc.json index c30e5a97..3d8d64aa 100644 --- a/.commitlintrc.json +++ b/.commitlintrc.json @@ -1,3 +1,4 @@ { - "extends": ["@commitlint/config-conventional"] + "extends": ["@commitlint/config-conventional"], + "helpUrl": "https://github.com/chapter-three/next-drupal/blob/main/CONTRIBUTING.md#commits" } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20d96f24..d413922e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Thanks for your interest in contributing to Next.js for Drupal. We're happy to have you here. +Thanks for your interest in contributing to Next.js for Drupal. We're happy to have you here. Please take a moment to review this document before submitting your first pull request. @@ -90,3 +90,104 @@ yarn phpcs Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests. +## Commits + +This project uses git commit messages that follow the [Conventional Commits format](https://www.conventionalcommits.org/en/v1.0.0/). A minor change to your commit message style can: + +- make you a better programmer +- helps to automate the CHANGELOG generated for other developers + +Don’t worry. You can still submit a Pull Request and if you don’t properly use semantic commit messages, we will edit the commits to add them. But we like them, so you might too. + +### Format of the commit message: + +``` +(): + + + +