Skip to content

Commit

Permalink
Update README supported by ChatGPT (#97)
Browse files Browse the repository at this point in the history
  • Loading branch information
toshimaru authored Sep 26, 2023
1 parent ad9853f commit 4faf79f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

# auto-author-assign

GitHub Actions: Assign pull request author automatically.
GitHub Actions: Automatically assign pull request authors.

![OG image](./img/auto-author-assign.jpg)

## Why this action?

In most cases, pull request author should be assigned an assignee of the pull request.
In most cases, the pull request author should be assigned as an **assignee** of the pull request.

This action automatically assigns PR author as an assignee.
This action automatically assigns the pull request author as an assignee.

## Usage

Expand Down Expand Up @@ -48,9 +48,9 @@ jobs:
If not specified, `GITHUB_TOKEN` will be used by default.

## Enable auto-author-assign for the issues
## Enable auto-author-assign for issues

An issue author can be automatically assigned as an issue assignee.
An issue's author can be automatically assigned as an issue assignee.

- Add `issues` to the trigger
- Add `issues: write` to the permissions
Expand All @@ -70,9 +70,9 @@ jobs:
...
```

## Skip assigning author
## Skip assigning the author

`auto-author-assign` action skips assigning the author when:
The `auto-author-assign` action skips assigning the author when:

- Someone is already assigned as an assignee
- The author is a bot
1. Someone is already assigned as an assignee
1. The author is a bot
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "auto-author-assign",
"version": "2.0.0",
"private": true,
"description": "GitHub Actions: Assign the pull request author automatically.",
"description": "GitHub Actions: Automatically assign pull request authors",
"scripts": {
"build": "ncc build src/index.js",
"release": "standard-version",
Expand Down

0 comments on commit 4faf79f

Please sign in to comment.