Skip to content

Commit f82832b

Browse files
committed
Fix up README slightly
1 parent f195a02 commit f82832b

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
# PythonistaGuild PR Description Check Action
1+
# Pythonista PR Description Check Action
22

3-
A small action to check whether specific strings are contained in the body/description of a PR.
4-
5-
6-
Useful for checking whether certain conditions have been agreed to E.g. with [x] or []
3+
Action which checks whether a specific string is contained within a PR description.
4+
This is useful for checking whether certain conditions have been met, e.g. signing an agreement.
75

86
## To Use:
97

10-
**Make a workflow:**
8+
**Create a workflow:**
119

1210
```yaml
13-
name: pr-description-check
11+
name: validate-description
1412
on:
1513
pull_request:
1614
types:
@@ -21,10 +19,9 @@ jobs:
2119
validate:
2220
runs-on: ubuntu-latest
2321
steps:
24-
- name: checkout repository
25-
uses: actions/checkout@v4
2622
- name: PR Description Check
2723
uses: pythonistaguild/[email protected]
2824
with:
29-
content: "string to check exists"
25+
# Check whether the author has enabled this checkbox
26+
content: "[x] Python is my favorite programming language!"
3027
```

0 commit comments

Comments
 (0)