chore: general improvements of config files

.commitlintrc.json

@@ -0,0 +1 @@
+{ "extends": ["@commitlint/config-conventional"] }

.github/ISSUE_TEMPLATE/BUG.md

@@ -1,6 +1,7 @@
 ---
 name: '🐛 Bug Report'
 about: 'Report an unexpected problem or unintended behavior.'
+title: '[Bug]'
 labels: 'bug'
 ---
 

.github/ISSUE_TEMPLATE/DOCUMENTATION.md

@@ -1,6 +1,7 @@
 ---
 name: '📜 Documentation'
 about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
+title: '[Documentation]'
 labels: 'documentation'
 ---
 
@@ -10,11 +11,12 @@ Please make sure your issue has not already been fixed.
 Please place an x (no spaces - [x]) in all [ ] that apply.
 -->
 
-### Documentation :
+## Documentation
 
-- [ ] Is Missing
+<!-- Please uncomment the type of documentation problem this issue address -->
-- [ ] Is Confusing
-- [ ] Has Typo errors
-- [ ] Not Sure?
 
-### Proposal
+<!-- Documentation is Missing -->
+<!-- Documentation is Confusing -->
+<!-- Documentation has Typo errors -->
+
+## Proposal

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,19 +1,20 @@
 ---
 name: '✨ Feature Request'
 about: 'Suggest a new feature idea.'
+title: '[Feature]'
 labels: 'feature request'
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->
 
-### Description
+## Description
 
 <!-- A clear and concise description of the problem or missing capability... -->
 
-### Describe the solution you'd like
+## Describe the solution you'd like
 
 <!-- If you have a solution in mind, please describe it. -->
 
-### Describe alternatives you've considered
+## Describe alternatives you've considered
 
 <!-- Have you considered any alternative solutions or workarounds? -->

.github/ISSUE_TEMPLATE/IMPROVEMENT.md

@@ -1,6 +1,7 @@
 ---
 name: '🔧 Improvement'
 about: 'Improve structure/format/performance/refactor/tests of the code.'
+title: '[Improvement]'
 labels: 'improvement'
 ---
 
@@ -10,12 +11,14 @@ Please make sure your issue has not already been fixed.
 Please place an x (no spaces - [x]) in all [ ] that apply.
 -->
 
-### Type of Improvement :
+## Type of Improvement
 
-- [ ] Files and Folders Structure
+<!-- Please uncomment the type of improvements this issue address -->
-- [ ] Performance
-- [ ] Refactoring code
-- [ ] Tests
-- [ ] Not Sure?
 
-### Proposal
+<!-- Files and Folders Structure -->
+<!-- Performance -->
+<!-- Refactoring code -->
+<!-- Tests -->
+<!-- Not Sure? -->
+
+## Proposal

.github/ISSUE_TEMPLATE/QUESTION.md

@@ -1,6 +1,7 @@
 ---
 name: '🙋 Question'
 about: 'Further information is requested.'
+title: '[Question]'
 labels: 'question'
 ---
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,19 +9,8 @@ Please place an x (no spaces - [x]) in all [ ] that apply.
 
 -->
 
-### What type of change does this PR introduce?
+## What changes this PR introduce?
 
-- [ ] Bugfix
+## List any relevant issue numbers
-- [ ] Feature
-- [ ] Refactor
-- [ ] Documentation
-- [ ] Not Sure?
 
-### Does this PR introduce breaking changes?
+## Is there anything you'd like reviewers to focus on?
-
-- [ ] Yes
-- [ ] No
-
-### List any relevant issue numbers:
-
-### Description:

.github/workflows/commitlint.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   commitlint:
     if: ${{ (github.event_name == 'push') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && (github.event.review.author_association == 'COLLABORATOR' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'OWNER') && !github.event.pull_request.draft && github.event.pull_request.state == 'open') }}
-    runs-on: ubuntu-latest
+    runs-on: 'ubuntu-latest'
     steps:
       - uses: 'actions/checkout@v2'
         with:

.github/workflows/nodejs.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   ci_app:
     if: ${{ (github.event_name == 'push') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && (github.event.review.author_association == 'COLLABORATOR' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'OWNER') && !github.event.pull_request.draft && github.event.pull_request.state == 'open') }}
-    runs-on: ubuntu-latest
+    runs-on: 'ubuntu-latest'
     strategy:
       matrix:
         node-version: [14.x]
@@ -27,8 +27,7 @@ jobs:
       - name: 'Cache dependencies'
         uses: 'actions/cache@v2.1.4'
         with:
-          path: |
+          path: '**/node_modules'
-            **/node_modules
           key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
 
       - name: 'Install dependencies'
@@ -37,6 +36,9 @@ jobs:
       - name: 'Lint'
         run: 'npm run lint'
 
+      - name: 'MarkdownLint'
+        run: 'npm run markdownlint'
+
       - name: 'Build'
         run: 'npm run build'
 

.husky/pre-commit

@@ -2,3 +2,4 @@
 . "$(dirname "$0")/_/husky.sh"
 
 npm run lint
+npm run markdownlint

.markdownlint.json

@@ -0,0 +1,7 @@
+{
+  "default": true,
+  "MD013": false,
+  "MD024": false,
+  "MD033": false,
+  "MD041": false
+}

.yarnrc

@@ -1,2 +1,2 @@
-install.no-lockfile true
+--install.no-lockfile true
 save-exact true

commitlint.config.js

@@ -1 +0,0 @@
-module.exports = { extends: ['@commitlint/config-conventional'] }

package.json

@@ -27,7 +27,9 @@
   "homepage": "https://github.com/Thream/socketio-jwt#readme",
   "release-it": {
     "git": {
-      "commitMessage": "chore(release): v${version}"
+      "commit": false,
+      "push": false,
+      "tag": false
     },
     "github": {
       "release": false
@@ -38,6 +40,8 @@
     "hooks": {
       "before:init": [
         "npm run lint",
+        "npm run markdownlint",
+        "npm run build",
         "npm run test"
       ]
     },
@@ -66,6 +70,7 @@
   },
   "scripts": {
     "build": "rimraf ./build && tsc",
+    "markdownlint": "markdownlint '**/*.md' --ignore node_modules",
     "lint": "ts-standard | snazzy",
     "format": "ts-standard --fix | snazzy",
     "release": "release-it",
@@ -89,14 +94,15 @@
     "@types/express": "4.17.11",
     "@types/jest": "26.0.20",
     "@types/jsonwebtoken": "8.5.0",
-    "@types/node": "14.14.26",
+    "@types/node": "14.14.27",
     "@types/server-destroy": "1.0.1",
     "axios": "0.21.1",
     "express": "4.17.1",
     "husky": "5.0.9",
     "jest": "26.6.3",
+    "markdownlint-cli": "0.26.0",
     "pinst": "2.1.4",
-    "release-it": "14.3.0",
+    "release-it": "14.4.0",
     "rimraf": "3.0.2",
     "server-destroy": "1.0.1",
     "snazzy": "9.0.0",