From f0893a12974803104792c18d639c2a41f0b7f4ae Mon Sep 17 00:00:00 2001
From: xiaoweii <xiaoweii@amazom.com>
Date: Fri, 27 Oct 2023 11:24:00 +0800
Subject: [PATCH] fix: fix the comment issue

---
 .github/workflows/title-lint.yml | 53 +++++++++++---------------------
 README.md                        |  4 +--
 example/README.md                |  2 +-
 3 files changed, 21 insertions(+), 38 deletions(-)

diff --git a/.github/workflows/title-lint.yml b/.github/workflows/title-lint.yml
index c3cf4bb..5b392f7 100644
--- a/.github/workflows/title-lint.yml
+++ b/.github/workflows/title-lint.yml
@@ -1,48 +1,31 @@
-name: Commit Title Lint
+name: Pull Request Title Lint
 
 on:
-  pull_request:
-    branches: [ "main" ]
+  pull_request_target:
+    types:
+      - labeled
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+      - edited
 
 jobs:
   title-lint:
+    name: Validate PR title
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
     steps:
-      - uses: amannn/action-semantic-pull-request@v3.2.6
+      - uses: amannn/action-semantic-pull-request@v5.0.2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          # Configure which types are allowed.
-          # Default: https://github.com/commitizen/conventional-commit-types
-          types: |
-            fix
+          types: |-
             feat
+            fix
+            chore
             docs
-            style
-            refactor
-            perf
-            test
-            build
             ci
-            chore
-            revert
-            release
-          # Configure that a scope must always be provided.
-          requireScope: false
-          # Configure additional validation for the subject based on a regex.
-          # This example ensures the subject doesn't start with an uppercase character.
-          subjectPattern: ^(?![A-Z]).+$
-          # If `subjectPattern` is configured, you can use this property to override
-          # the default error message that is shown when the pattern doesn't match.
-          # The variables `subject` and `title` can be used within the message.
-          subjectPatternError: |
-            The subject "{subject}" found in the pull request title "{title}"
-            didn't match the configured pattern. Please ensure that the subject
-            doesn't start with an uppercase character.
-          # For work-in-progress PRs you can typically use draft pull requests
-          # from Github. However, private repositories on the free plan don't have
-          # this option and therefore this action allows you to opt-in to using the
-          # special "[WIP]" prefix to indicate this state. This will avoid the
-          # validation of the PR title and the pull request checks remain pending.
-          # Note that a second check will be reported if this is enabled.
-          wip: true
+            tests
+          requireScope: false
\ No newline at end of file
diff --git a/README.md b/README.md
index 5db76b0..227213a 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
 
 ## Introduction
 
-Clickstream Flutter SDK can help you easily collect and report events from browser to AWS. This SDK is part of an AWS solution - [Clickstream Analytics on AWS](https://github.com/awslabs/clickstream-analytics-on-aws), which provisions data pipeline to ingest and process event data into AWS services such as S3, Redshift.
+Clickstream Flutter SDK can help you easily collect and report events from your mobile app to AWS. This SDK is part of an AWS solution - [Clickstream Analytics on AWS](https://github.com/awslabs/clickstream-analytics-on-aws), which provisions data pipeline to ingest and process event data into AWS services such as S3, Redshift.
 
-The SDK relies on the [Clickstream Android SDK](https://github.com/awslabs/clickstream-android) and [Clickstream Swift SDK](https://github.com/awslabs/clickstream-swift). Therefore, flutter SDK also supports automatically collect common user events and attributes (e.g., session start, first open) In addition, we've added easy-to-use APIs to simplify data collection in Flutter apps.
+The SDK relies on the [Clickstream Android SDK](https://github.com/awslabs/clickstream-android) and [Clickstream Swift SDK](https://github.com/awslabs/clickstream-swift). Therefore, flutter SDK also supports automatically collect common user events and attributes (e.g., session start, first open). In addition, we've added easy-to-use APIs to simplify data collection in Flutter apps.
 
 ## Integrate SDK
 
diff --git a/example/README.md b/example/README.md
index fc3f593..651e890 100644
--- a/example/README.md
+++ b/example/README.md
@@ -1,4 +1,4 @@
-# clickstream_flutter_example
+# Clickstream Flutter SDK Example
 
 Demonstrates how to use the clickstream_flutter plugin.