Skip to content

Commit c22b8b6

Browse files
committed
Set up pre-commit GitHub action and make README clearer
1 parent 841a920 commit c22b8b6

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

.github/workflows/pre-commit.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: pre-commit
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [master]
7+
8+
jobs:
9+
pre-commit:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- uses: actions/setup-python@v2
14+
- uses: pre-commit/[email protected]

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,8 @@ next_url = page1.next_page_url
196196
page2 = shopify.Product.find(from_=next_url)
197197
```
198198

199-
## Development on this repo
200-
Install requirements and initialize [pre-commit](https://pre-commit.com/)
199+
## Set up pre-commit locally [OPTIONAL]
200+
[Pre-commit](https://pre-commit.com/) is set up as a GitHub action that runs on pull requests and pushes to the `master` branch. If you want to run pre-commit locally, install it and set up the git hook scripts
201201
```shell
202202
pip install -r requirements.txt
203203
pre-commit install

0 commit comments

Comments
 (0)