Skip to content

Commit

Permalink
[DOCS] Fix typos and missing punctuation in README (#44)
Browse files Browse the repository at this point in the history
Co-authored-by: Tibor Eszes <tibor.eszes@container-solutions.com>
  • Loading branch information
teszes and Tibor Eszes authored Jul 7, 2021
1 parent 81ad200 commit 8208759
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
![Version](https://img.shields.io/github/v/release/gsactions/commit-message-checker?style=flat-square)
![Test](https://github.com/gsactions/commit-message-checker/workflows/build-test/badge.svg)

A GitHub action that checks that commit messages match a regex patter. The
A GitHub action that checks that commit messages match a regex pattern. The
action is able to act on pull request and push events and check the pull
request title and body or the commit message of the commits of a push.
request title and body, or the commit message of the commits of a push.

On pull requests the title and body are concatenated delimited by two line
On pull requests the title and body are concatenated, delimited by two line
breaks.

Designed to be very flexible in usage you can split checks into various
workflows, using action types on pull request to listen on, define branches
Designed to be very flexible in usage, you can split checks into various
workflows, use action types on pull request to listen on, define branches
for pushes etc. etc.

## Configuration
Expand Down Expand Up @@ -119,11 +119,11 @@ Runs Jest test suites.

#### `npm run all`

Runs all of the above commands.
Runs all the above commands.

### Debugging

More information about debugging Github Actions can be found at <https://github.com/actions/toolkit/blob/main/docs/action-debugging.md>.
More information about debugging GitHub Actions can be found at <https://github.com/actions/toolkit/blob/main/docs/action-debugging.md>.

The secrets `ACTIONS_STEP_DEBUG` and `ACTIONS_RUNNER_DEBUG` are both set to
`true` in the main repository.
Expand Down

0 comments on commit 8208759

Please sign in to comment.