diff --git a/README.md b/README.md index 848bbf0..478a8d4 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) [![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) -A Github Action for checking commit message formatting, branch naming, committer name, email, commit signoff and more. +A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more. ## Table of Contents @@ -33,7 +33,7 @@ on: jobs: commit-check: runs-on: ubuntu-latest - permissions: # use permissions because of use pr-comments + permissions: # use permissions because use of pr-comments contents: read pull-requests: write steps: @@ -43,7 +43,7 @@ jobs: fetch-depth: 0 # required for merge-base check - uses: commit-check/commit-check-action@v1 env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because use of pr-comments with: message: true branch: true @@ -51,7 +51,7 @@ jobs: author-email: true commit-signoff: true merge-base: false - imperative: true + imperative: false job-summary: true pr-comments: ${{ github.event_name == 'pull_request' }} ``` @@ -81,13 +81,13 @@ jobs: ### `message` - **Description**: check commit message formatting convention. - - By default the rule follows [conventional commits](https://www.conventionalcommits.org/). + - By default, the rule follows [conventional commits](https://www.conventionalcommits.org/). - Default: `true` ### `branch` - **Description**: check git branch naming convention. - - By default the rule follows [conventional branch](https://conventional-branch.github.io/). + - By default, the rule follows [conventional branch](https://conventional-branch.github.io/). - Default: `true` ### `author-name` @@ -107,13 +107,13 @@ jobs: ### `merge-base` -- **Description**: check current branch is rebased onto target branch. +- **Description**: check current branch is rebased onto the target branch. - Default: `false` > [!IMPORTANT] -> `merge-base` is an experimental feature. by default it's disable. +> `merge-base` is an experimental feature. By default, it's disabled. > -> To use this feature, you need fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`. +> To use this feature, you need to fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`. ### `imperative` @@ -122,7 +122,7 @@ jobs: ### `dry-run` -- **Description**: run checks without failing. exit code is 0 otherwise is 1. +- **Description**: run checks without failing. exit code is 0; otherwise is 1. - Default: `false` ### `job-summary` @@ -136,11 +136,11 @@ jobs: - Default: `false` > [!IMPORTANT] -> `pr-comments` is an experimental feature. by default it's disable. To use it you need to set `GITHUB_TOKEN` in the GitHub Action. +> `pr-comments` is an experimental feature. By default, it's disabled. To use it, you need to set `GITHUB_TOKEN` in the GitHub Action. > > This feature currently doesn’t work with forked repositories. For more details, refer to issue [#77](https://github.com/commit-check/commit-check-action/issues/77). -Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml), if you want to customize just add your `.commit-check.yml` config file under your repository root directory. +Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml). If you want to customize, just add your `.commit-check.yml` config file under your repository root directory. ## GitHub Action Job Summary @@ -191,4 +191,4 @@ Versioning follows [Semantic Versioning](https://semver.org/). ## Have questions or feedback? -To provide feedback (requesting a feature or reporting a bug) please post to [issues](https://github.com/commit-check/commit-check/issues). +To provide feedback (requesting a feature or reporting a bug), please post to [issues](https://github.com/commit-check/commit-check/issues).