Skip to content

[DOCS] Fix typos and missing punctuation in README #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2021
Merged

[DOCS] Fix typos and missing punctuation in README #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
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