Skip to content

Commit 4faf79f

Browse files
authored
Update README supported by ChatGPT (#97)
1 parent ad9853f commit 4faf79f

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
# auto-author-assign
44

5-
GitHub Actions: Assign pull request author automatically.
5+
GitHub Actions: Automatically assign pull request authors.
66

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

99
## Why this action?
1010

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

13-
This action automatically assigns PR author as an assignee.
13+
This action automatically assigns the pull request author as an assignee.
1414

1515
## Usage
1616

@@ -48,9 +48,9 @@ jobs:
4848
4949
If not specified, `GITHUB_TOKEN` will be used by default.
5050

51-
## Enable auto-author-assign for the issues
51+
## Enable auto-author-assign for issues
5252

53-
An issue author can be automatically assigned as an issue assignee.
53+
An issue's author can be automatically assigned as an issue assignee.
5454

5555
- Add `issues` to the trigger
5656
- Add `issues: write` to the permissions
@@ -70,9 +70,9 @@ jobs:
7070
...
7171
```
7272

73-
## Skip assigning author
73+
## Skip assigning the author
7474

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

77-
- Someone is already assigned as an assignee
78-
- The author is a bot
77+
1. Someone is already assigned as an assignee
78+
1. The author is a bot

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "auto-author-assign",
33
"version": "2.0.0",
44
"private": true,
5-
"description": "GitHub Actions: Assign the pull request author automatically.",
5+
"description": "GitHub Actions: Automatically assign pull request authors",
66
"scripts": {
77
"build": "ncc build src/index.js",
88
"release": "standard-version",

0 commit comments

Comments
 (0)