feat: add PR template, add commit lint

dotintent · Dec 4, 2020 · ec30b38 · ec30b38
1 parent 066220f
commit ec30b38
Show file tree

Hide file tree

Showing 8 changed files with 581 additions and 26 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 node_modules/
 dist/
+.docusaurus/
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,17 @@
+## Overview of PR
+
+<!-- Filling out the template is required. Be sure to add all applicable labels! -->
+<!-- Give a general overview of the PR -->
+
+## Technical & Architecture Changes
+
+<!-- Explain any architecture changes/decisions here, if any-->
+<!-- Number of new packages in package.json -->
+<!-- Link any relevant documents -->
+<!-- Screenshots (frontend) -->
+
+## TODO
+
+<!-- Any outstanding ToDos? -->
+<!-- `- [ ] task` == todo -->
+<!-- `- [x] task` == done -->
diff --git a/.huskyrc.js b/.huskyrc.js
@@ -1,5 +1,6 @@
 module.exports = {
   hooks: {
     'pre-commit': 'lint-staged',
+    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS',
   },
 };
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,3 @@
 node_modules
 dist
+.docusaurus
diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@
   - [Installation](#-installation)
   - [Prepare and fill secrets](#-prepare-and-fill-secrets)
   - [Running the app](#-running-the-app)
+- [Conventional Commits](#-conventional-commits)
 - [Available scripts](#-available-scripts)
 - [Useful docs](#-useful-docs)
 
@@ -44,6 +45,19 @@ Copy and paste .env.example into .env and fill all secrets.
 yarn storybook
 ```
 
+## Conventional Commits
+
+Commitlint checks if your commit messages meet the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format.
+
+Example:
+
+```git
+feat(blog): add comment section
+```
+
+Common types according to commitlint-config-conventional (based on the the Angular convention) can be:
+[conventional-commit-types](https://github.com/commitizen/conventional-commit-types/blob/master/index.json)
+
 ## Available scripts
 
 To run script, in terminal type `yarn {script}`.

diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };
diff --git a/package.json b/package.json
@@ -60,6 +60,8 @@
   },
   "devDependencies": {
     "@babel/core": "^7.12.3",
+    "@commitlint/cli": "^11.0.0",
+    "@commitlint/config-conventional": "^11.0.0",
     "@storybook/addon-actions": "^6.0.28",
     "@storybook/addon-controls": "^6.0.28",
     "@storybook/addon-essentials": "^6.0.28",