Merge pull request #81 from scribd/helen/SERF-2048/commit-message-check

[SERF-2048] Relax the requirement in PR commit message check workflow

Author: azclub

.github/workflows/pr-check.yml

@@ -1,4 +1,4 @@
-name: 'Commit Message Check'
+name: Commit Message Check
 on:
   pull_request:
     types:
@@ -12,11 +12,11 @@ jobs:
     name: Check Commit Message
     runs-on: ubuntu-20.04
     steps:
-      - name: Check Commit Message Title
+      - name: Check Commit Message
         uses: gsactions/commit-message-checker@v2
         with:
-          pattern: '^(?:feat|fix|docs|style|refactor|perf|test|chore)\(?(?:\w+|\s|\-|_)?\)?:\s[A-Z]\w+'
-          error: 'The commit title does not follow the requirements. Please check the commit message requirements here: https://github.com/scribd/go-sdk#commit-messages'
+          pattern: '^(?:ci|feat|fix|docs|style|refactor|perf|test|chore)\(?(?:\w+|\s|\-|_)?\)?:\s\w+'
+          error: "One or more commit messages do not meet the format requirements. Please check the requirements here: https://github.com/scribd/go-sdk#commit-messages"
           accessToken: ${{ secrets.GITHUB_TOKEN }}
           excludeTitle: true
           excludeDescription: true

README.md

@@ -1471,18 +1471,7 @@ In this case, perform the following steps:
 
 ### Commit messages
 
-In order to generate a consistent and readable CHANGELOG, the commit title should being with a capital letter.
-
-Examples:
-```
-// incorrect
-feat(ci): some CI changes
-
-// correct
-feat(ci): Some CI changes
-```
-
-[The GitHub workflow checks the commit title correctness](https://github.com/scribd/go-sdk/blob/main/.github/workflows/pr-check.yml).
+Please follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [Angular commit message guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) for writing commit messages.
 
 ## Release