ci: Add PR title checker workflow and thank-you comment on merge (#1385)

Co-authored-by: Aaron <[email protected]>

Author: okineadev

.commitlintrc.yml

@@ -0,0 +1,10 @@
+extends:
+  - '@commitlint/config-conventional'
+rules:
+  subject-case:
+    - 0
+    - always
+    - - sentence-case
+      - start-case
+      - pascal-case
+      - upper-case

.github/workflows/pr-closed.yml

@@ -0,0 +1,27 @@
+name: 🎉 PR closed
+
+on:
+  pull_request_target:
+    types:
+      - closed
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  thank-you:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Post Thank You Comment
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        env:
+          comment: Thanks for helping make WXT better!
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: process.env.comment
+            })

.github/workflows/pr-title.yml

@@ -0,0 +1,26 @@
+name: ✅ Check PR Title
+
+on:
+  pull_request:
+    types: [opened, edited]
+
+jobs:
+  lint-pr-title:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          # Only fetch the config file from the repository
+          sparse-checkout-cone-mode: false
+          sparse-checkout: .commitlintrc.yml
+
+      - name: Install dependencies
+        run: npm install --global @commitlint/config-conventional commitlint
+
+      - name: Check PR title with commitlint
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+          HELP_URL: https://github.com/wxt-dev/wxt/blob/main/CONTRIBUTING.md#conventional-pr-titles
+        run: echo "$PR_TITLE" | npx commitlint --help-url $HELP_URL

CONTRIBUTING.md

@@ -8,9 +8,17 @@ If you want to add a new feature, please create an issue or discussion first so
 
 ## Conventional Commits
 
-This project uses [Conventional Commits](https://www.conventionalcommits.org/en) to automate versioning. If you're a new contributor, don't worry about this. When you open a PR, a maintainer will change the PR's title so it's in the style of conventional commits, but that's all.
+This project uses [Conventional Commit format](https://www.conventionalcommits.org/en/v1.0.0/) to automatically generate a changelog and better understand the changes in the project
 
-Maintainers, commits to the `main` branch (either directly or via PRs) must be valid conventional commits.
+Here are some examples of conventional commit messages:
+
+- `feat: add new functionality`
+- `fix: correct typos in code`
+- `ci: add GitHub Actions for automated testing`
+
+## Conventional PR Titles
+
+The title of your pull request should follow the [conventional commit format](#conventional-commits). When a pull request is merged to the main branch, all changes are going to be squashed into a single commit. The message of this commit will be the title of the pull request. And for every release, the commit messages are used to generate the changelog.
 
 ## Setup
 

package.json

@@ -19,6 +19,8 @@
   "devDependencies": {
     "@aklinker1/buildc": "^1.1.4",
     "@aklinker1/check": "^1.4.5",
+    "@commitlint/config-conventional": "^19.7.1",
+    "@commitlint/types": "^19.5.0",
     "@types/fs-extra": "^11.0.4",
     "@vitest/coverage-v8": "^2.1.4",
     "changelogen": "^0.5.7",