polish(conv-commit): Improve errmsg, doc link

vEnhance · Jan 2, 2025 · 94a5927 · 94a5927
1 parent 51ca202
commit 94a5927
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/.github/workflows/conv-commit.yml b/.github/workflows/conv-commit.yml
@@ -47,7 +47,11 @@ jobs:
           message: |
             Hey there and thank you for opening this pull request! 👋
 
-            We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/). For most of you, this means that the PR title should say either
+            *We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).* This comment indicates a fix is needed to repair this.
+
+            ## How do I fix this?
+
+            For most of you, this means that the PR title should say either
 
             - `fix: [short description here]` (if you are fixing an issue)
             - `feat: [short description here]` (if you are introducing a new feature)
@@ -69,6 +73,6 @@ jobs:
 
             Please adjust the proposed title and this check will resolve automatically!
 
-            ```text
+            ## Detailed error message
+
             ${{ steps.lint_pr_title.outputs.error_message }}
-            ```
diff --git a/commit-types.md b/commit-types.md
@@ -20,3 +20,5 @@ Evan uses the following types:
 - `revert`: revert commits
 - `style`: code style changes
 - `test`: unit testing, etc.
+
+See [the corresponding GitHub action](.github/workflows/conv-commit.yml).