Skip to content

Clean doc #1

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
burisu merged 1 commit into from
Mar 6, 2026
Merged

Clean doc #1

Show file tree
Hide file tree
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
Binary file removed .github/images/example-github-pr-review.png
View file
Open in desktop
Binary file not shown.
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GitHub Action: Run yarn-audit with reviewdog :dog:
# GitHub Action: Run "yarn audit" with reviewdog :dog:

[![Test](https://github.com/codeur/action-yarn-audit/workflows/Test/badge.svg)](https://github.com/codeur/action-yarn-audit/actions?query=workflow%3ATest)
[![reviewdog](https://github.com/codeur/action-yarn-audit/workflows/reviewdog/badge.svg)](https://github.com/codeur/action-yarn-audit/actions?query=workflow%3Areviewdog)
Expand All @@ -20,9 +20,7 @@ code review experience.

### With `github-pr-review`

With `reporter: github-pr-review` a comment is added to the Pull Request Conversation:

![Example comment made by the action, with github-pr-review](/.github/images/example-github-pr-review.png)
With `reporter: github-pr-review` a comment is added to the Pull Request Conversation.

Copilot AI Mar 6, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor grammar: add a comma after the introductory clause so the sentence reads more naturally (e.g., after github-pr-review).

Suggested change
With `reporter: github-pr-review` a comment is added to the Pull Request Conversation.
With `reporter: github-pr-review`, a comment is added to the Pull Request Conversation.

Copilot uses AI. Check for mistakes.

## Inputs

Expand Down