Skip to content

Commit

Permalink
chore: update read me to match v2 a bit better (#793)
Browse files Browse the repository at this point in the history
  • Loading branch information
myyk committed May 29, 2023
1 parent 7800e25 commit d356e68
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,13 @@ before letting a pull request be mergeable.
## How it works

When a Pull Request is made to your repository's main branch, a new comment is
posted by the action on the PR automatically as a place for :thumbsup:/
:thumbsdown: votes to be cast.
posted by the action that shows the status of the vote (which will generally be a not passing vote).

Only configured voters are counted. Votes are counted when the action is rerun
by manual rerunning it. Failed votes will list reasons why the vote failed in
Approvals or Requesting Changes on the Pull Request is the mechanism to cast a vote. Although, only
configured voters are counted. Failed votes will list the reasons why the vote failed in
the action's error messaging.

When a Pull Request is update, it will clear the voting and restart the vote
with the default settings.
When a Pull Request is update, it will clear the vote as the Pull Request reviews are cleared.

## Usage

Expand Down

0 comments on commit d356e68

Please sign in to comment.