Skip to content

Commit c898504

Browse files
author
Maksim Minko
committed
update README
1 parent 9e00553 commit c898504

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Pull Request Auto Reviewer (GitHub Action)
22

3-
![action example](./img/example.jpg)
3+
![action example](./img/example.jpeg)
44

55
_This script is for public repositories. For private ones use a [simplified version](https://github.com/marketplace/actions/pull-request-auto-reviewer-private) of it._
66

@@ -13,17 +13,23 @@ Add review comments to your pull requests based on changes in 3 steps:
1313
- checks:
1414
- paths: "**/*.js"
1515
message: |
16-
### Please tick the following checkboxes:
16+
### As you changed javascript file(s) tick the following checks:
1717
18-
- [ ] the code is tested
19-
- [ ] files are compressed
20-
- [ ] files contain no errors
18+
- [ ] unit/integration tests are added
19+
- [ ] no performance implications
20+
- [ ] relevant documentation is added/updated
21+
- paths: "package-lock.json"
22+
message: |
23+
### Since you've added/updated dependencies, pay attention to this:
24+
25+
- [ ] clear reasoning for adding or updating the dependency is provided
26+
- [ ] no security implications or concerns related to the dependency
2127
```
2228
2329
2. Add artifact uploading config [(more info)](#add-artifact-uploading-config):
2430
2531
```yml
26-
name: Auto-review Diff Prepare
32+
name: Auto Review Prepare
2733
on:
2834
pull_request:
2935
branches:

img/example.jpeg

242 KB
Loading

img/example.jpg

-256 KB
Binary file not shown.

0 commit comments

Comments
 (0)