Skip to content

Commit

Permalink
docs: update readme (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
nejdetkadir authored Nov 23, 2023
1 parent 559a30c commit 7eaf7d4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Repository CODEOWNERS

* @shft-tech
* @sonergonencler @nejdetkadir
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

This GitHub Action reviews the content of opened Pull Requests based on provided inputs. The Pull Request contains a checklist that is used to determine if specific requirements are met. If the PR does not meet the requirements, it comments on the PR with a list of missing requirements.

## Installation
Go to the [documentation](https://github.com/shftco/shft-config/tree/main/pullmate) to learn more.

## Usage

The belowing YAML code outlines the configuration for using the "SHFT PullMate" GitHub Action. In this setup, the action is triggered whenever a pull request event occurs. This includes events such as when a pull request is opened, closed, labeled, or when changes are made to it. The action is designed to operate concurrently with other actions, ensuring that multiple pull requests can be processed simultaneously.
Expand Down

0 comments on commit 7eaf7d4

Please sign in to comment.