chore(contributions): add conventional commits to lint pr titles (#351)

* commitlint init

* chore(husky): initialize husky pre-commit and enforce commit-msg

* chore(contributions): add commit lint information on contributions.md

* chore(contributing): update md

* chore(workflow): add commitlint github workflow

* chore(workflow): commit lint pr title

* do not lint commit msg, just pr

* remove commitlint config from eslintignore

* re-add dev deps

.eslintignore

@@ -2,6 +2,7 @@
 vite-env.d.ts
 polyfills.ts
 vite.config.ts
+commitlint.config.ts
 
 # Temporarily ignore, we will slowly remove each directory as we fix files to follow ESLint rules
 /src/components

.github/workflows/commitlint.yml

@@ -0,0 +1,31 @@
+name: Lint PR Title
+on:
+  pull_request:
+    types: ['opened', 'edited', 'reopened', 'synchronize']
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up pnpm
+        uses: dydxprotocol/setup-pnpm@v1
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: pnpm
+
+      - name: Install dependencies
+        run: |
+          pnpm install @commitlint/config-conventional
+          echo "module.exports = {extends: ['@commitlint/config-conventional'], rules: { 'subject-case': [0,'always',['sentence-case']],'header-max-length': [2, 'always', 120], 'body-max-line-length': [0, 'always', 120] }};" > commitlint.config.js
+
+      - name: Lint PR Title
+        run: |
+          echo "${PR_TITLE}" | pnpx commitlint --config commitlint.config.ts
+        env:
+          PR_TITLE: '${{ github.event.pull_request.title }}'

.husky/pre-commit

@@ -0,0 +1 @@
+pnpm test

CONTRIBUTING.md

@@ -17,6 +17,32 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 3. Make sure your code lints.
 4. Issue that pull request!
 
+## We use [Conventional Commits](https://github.com/conventional-changelog/commitlint)
+We use a commit-msg hook to check if your commit messages meet the conventional commit format.
+
+In general the pattern mostly looks like this:
+
+`type(scope?): subject`  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
+
+### Real world examples can look like this:
+`chore: run tests on travis ci`
+`fix(server): send cors headers`
+`feat(blog): add comment section`
+
+Common types according to commitlint-config-conventional can be:
+
+build
+chore
+ci
+docs
+feat
+fix
+perf
+refactor
+revert
+style
+test
+
 ## Any contributions you make will be under the same License
 When you submit code changes, your submissions are understood to be under the same [License](https://github.com/dydxprotocol/v4-web/blob/master/LICENSE) that covers the project.
 

commitlint.config.ts

@@ -0,0 +1 @@
+export default { extends: ['@commitlint/config-conventional'] };

package.json

@@ -27,9 +27,11 @@
     "ladle-p": "ladle preview",
     "lint": "eslint --ext .ts,.tsx src/",
     "fix-lint": "eslint --fix --ext .ts,.tsx src/",
-    "test": "vitest",
+    "test": "vitest run",
     "tsc": "tsc",
-    "postinstall": "tar -xzC public -f tradingview/tradingview.tgz"
+    "postinstall": "tar -xzC public -f tradingview/tradingview.tgz",
+    "prepare": "husky",
+    "commitlint": "commitlint --edit"
   },
   "packageManager": "[email protected]",
   "dependencies": {
@@ -118,6 +120,8 @@
   },
   "devDependencies": {
     "@babel/core": "^7.22.5",
+    "@commitlint/cli": "^19.0.3",
+    "@commitlint/config-conventional": "^19.0.3",
     "@dydxprotocol/v4-proto": "^3.0.0",
     "@ladle/react": "^4.0.2",
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
@@ -149,6 +153,7 @@
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "husky": "^9.0.11",
     "minimist": "^1.2.8",
     "node-fetch": "^3.3.1",
     "pnpm": "^8.6.6",