updated the readme.md file to make it more user friendly

.github/workflows/pr-title-checker.yaml

@@ -1,12 +1,9 @@
 name: 'PR Title Checker'
 on:
-  pull_request:
+  pull_request_target:
     types:
       - opened
-      - synchronize
-      - reopened
       - edited
-      - closed
 
 permissions:
   contents: write
@@ -28,26 +25,17 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           pass_on_octokit_error: false
           configuration_path: .github/pr-title-checker-config.json
-      - name: pt title satisfied
+
+      - name: PR title satisfied
         if: success()
         run: |
-          gh issue comment ${{ github.event.pull_request.number }} -R ${{ github.repository }} --body "Thank you ${{github.actor}}! Your PR title meets our guidelines."
+          gh issue comment ${{ github.event.pull_request.number }} -R ${{ github.repository }} --body  "Hey @${{ github.actor }}! Thanks for sticking to the guidelines! High five! 🙌🏻"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Close PR if title is invalid
         if: failure()
         run: |
-          gh pr close ${{ github.event.pull_request.number }} -R ${{ github.repository }}
-          gh issue comment ${{ github.event.pull_request.number }} -R ${{ github.repository }} --body $'Hello ${{github.actor}} Thank you for your PR. Unfortunately, it doesn\'t meet our quality checks.\n\nPlease ensure you follow our contribution guidelines. The PR title should match the required format.\n\nFor example, it should be like: `fix-#124: Added responsiveness to the Home page screen.`\n\nIf you have any query kindly check our [contributor guidelines](https://github.com/krishnaacharyaa/wanderlust/blob/main/.github/CONTRIBUTING.md).'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Reopen PR if title is corrected
-        if: github.event.action == 'edited' && success()
-        run: |
-          if [ "${{ github.event.pull_request.state }}" == "closed" ]; then
-            gh pr reopen ${{ github.event.pull_request.number }} -R ${{ github.repository }}
-          fi
+          gh issue comment ${{ github.event.pull_request.number }} -R ${{ github.repository }} --body $'Umm... did someone forget to read the style guide? Fix that PR title and let\'s try again! @${{ github.actor }}\nDon\'t worry, it happens to the best of us! Check out our [contributor guidelines](https://github.com/krishnaacharyaa/wanderlust/blob/main/.github/CONTRIBUTING.md) for more details.'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/validate-pr-template.yml

@@ -0,0 +1,70 @@
+name: Validate PR Template
+
+on:
+  pull_request_target:
+    types: [opened, edited]
+
+jobs:
+  validate-pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Validate PR description
+        id: validate
+        run: |
+          echo "Validating PR template..."
+
+          REQUIRED_SECTIONS=("## Summary" "## Description" "## Images" "## Issue(s) Addressed" "## Prerequisites")
+          INVALID_STRINGS=(
+            "_Briefly describe the purpose of this PR._"
+            "_Explain in detail what this PR is all about. This should include the problem you're solving, the approach taken, and any technical details that reviewers need to know._"
+            "_Include any relevant images or diagrams that can help reviewers visualize the changes, if applicable_"
+            "_Enter the issue number of the bug(s) that this PR fixes_"
+            "Template should be strictly **Closes <issue_number>**"
+            "Example: Closes #1"
+          )
+
+          PR_BODY=$(jq -r .pull_request.body < $GITHUB_EVENT_PATH)
+          echo "$PR_BODY"
+          MISSING_SECTIONS=()
+          for section in "${REQUIRED_SECTIONS[@]}"; do
+            if ! echo "$PR_BODY" | grep -q "$section"; then
+              MISSING_SECTIONS+=("$section")
+            fi
+          done
+
+          FOUND_INVALID_STRINGS=()
+          for invalid in "${INVALID_STRINGS[@]}"; do
+            if echo "$PR_BODY" | grep -q "$invalid"; then
+              FOUND_INVALID_STRINGS+=("$invalid")
+            fi
+          done
+
+          if [ ${#MISSING_SECTIONS[@]} -ne 0 ] || [ ${#FOUND_INVALID_STRINGS[@]} -ne 0 ]; then
+            echo "PR description is missing required sections or contains invalid strings."
+            echo "## Missing Sections:" >> $GITHUB_STEP_SUMMARY
+            printf '%s\n' "${MISSING_SECTIONS[@]}" >> $GITHUB_STEP_SUMMARY
+            echo "## Invalid Strings Found:" >> $GITHUB_STEP_SUMMARY
+            printf '%s\n' "${FOUND_INVALID_STRINGS[@]}" >> $GITHUB_STEP_SUMMARY
+            echo "{result}={failure}" >> $GITHUB_OUTPUT
+          else
+            echo "PR description meets the template requirements."
+            echo "{result}={success}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set PR label based on validation
+        if: ${{ steps.validate.outputs.result == 'failure' }}
+        run: |
+          gh pr edit ${{ github.event.pull_request.number }} --add-label "PR description needs formatting"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Remove PR label if validation passed
+        if: ${{ steps.validate.outputs.result == 'success' }}
+        run: |
+          gh pr edit ${{ github.event.pull_request.number }} --remove-label "PR description needs formatting"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

backend/.eslintrc.json

@@ -4,14 +4,17 @@
     "ecmaVersion": 12,
     "sourceType": "module"
   },
-  "extends": ["eslint:recommended", "prettier"],
+  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
   "env": {
     "jest": true,
     "es2021": true,
     "node": true
   },
-  "plugins": ["babel", "jest"],
+  "ignorePatterns": ["note_modules/"],
+
+  "plugins": ["babel", "jest", "prettier"],
   "rules": {
-    "no-console": "off"
+    "no-console": "off",
+    "import/extensions": "off"
   }
 }

backend/eslint.config.js

@@ -0,0 +1,4 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+
+export default [{ languageOptions: { globals: globals.browser } }, pluginJs.configs.recommended];

backend/package.json

@@ -15,7 +15,8 @@
   },
   "lint-staged": {
     "**/*.{js,ts,jsx,tsx}": [
-      "npx prettier --write"
+      "npx prettier --write",
+      "eslint --fix"
     ]
   },
   "scripts": {
@@ -34,10 +35,14 @@
   },
   "devDependencies": {
     "@babel/preset-env": "^7.23.2",
+    "@stylistic/eslint-plugin-js": "^2.1.0",
     "babel-jest": "^29.7.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint": "^9.3.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-babel": "^5.3.1",
     "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "globals": "^15.3.0",
     "jest": "^29.7.0",
     "lint-staged": "^15.2.2",
     "prettier": "^3.2.5",

frontend/.eslintrc.cjs

@@ -6,12 +6,14 @@ module.exports = {
     'plugin:@typescript-eslint/recommended-type-checked',
     'plugin:react-hooks/recommended',
     'plugin:@typescript-eslint/stylistic-type-checked',
-    'prettier',
+    'plugin:prettier/recommended'
   ],
-  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  ignorePatterns: ['dist', '.eslintrc.cjs', 'node_modules/'],
   parser: '@typescript-eslint/parser',
-  plugins: ['react-refresh'],
+  plugins: [
+    'react-refresh'
+  ],
   rules: {
-    'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
+    'react-refresh/only-export-components': ['warn', { allowConstantExport: true }]
   },
 };

frontend/eslint.config.js

@@ -0,0 +1,10 @@
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import pluginReactConfig from "eslint-plugin-react/configs/recommended.js";
+
+
+export default [
+  {languageOptions: { globals: globals.browser }},
+  ...tseslint.configs.recommended,
+  pluginReactConfig,
+];

frontend/package.json

@@ -15,7 +15,8 @@
   },
   "lint-staged": {
     "src/**/*.{js,ts,tsx,jsx}": [
-      "npx prettier --write"
+      "npx prettier --write",
+      "eslint --fix"
     ]
   },
   "dependencies": {
@@ -40,6 +41,9 @@
     "@babel/preset-env": "^7.23.6",
     "@babel/preset-react": "^7.23.3",
     "@babel/preset-typescript": "^7.23.3",
+    "@eslint/compat": "^1.0.1",
+    "@eslint/js": "^9.3.0",
+    "@stylistic/eslint-plugin-js": "^2.1.0",
     "@testing-library/dom": "^9.3.3",
     "@testing-library/jest-dom": "^6.1.5",
     "@testing-library/react": "^14.1.2",
@@ -53,10 +57,15 @@
     "@vitejs/plugin-react-swc": "^3.4.1",
     "@vitest/coverage-v8": "^1.6.0",
     "autoprefixer": "^10.4.16",
-    "eslint": "^8.53.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-babel": "^5.3.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.4",
+    "globals": "^15.3.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jsdom": "^24.0.0",
@@ -70,6 +79,7 @@
     "ts-jest-mock-import-meta": "^1.1.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.2.2",
+    "typescript-eslint": "^7.10.0",
     "vite": "^4.5.0",
     "vitest": "^1.6.0"
   }