docs: update readme

Author: shenxianpeng

.commit-check.yml

@@ -25,6 +25,6 @@ checks:
     suggest: run command `git config user.email yourname@example.com`
 
   - check: merge_base
-    regex: origin/main # it can be master, develop, devel etc based on your project.
+    regex: main # it can be master, develop, devel etc based on your project.
     error: Current branch is not rebased onto target branch
     suggest: please ensure your branch is rebased with the target branch

.github/workflows/commit-check.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}  # checkout PR HEAD commit
-          fetch-depth: 0  # all history for all branches and tags
+          fetch-depth: 0  # fetch all history for all branches and tags
       - uses: ./ # self test
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments

README.md

@@ -80,6 +80,8 @@ jobs:
 
 > [!IMPORTANT]
 > `merge-base` is an experimental feature. by default it's disable.
+> 
+> To use this feature, you need fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`.
 
 ### `dry-run`