Skip to content

Commit 9a019ff

Browse files
committed
Updates to README.md based on feedback
1 parent 09b9a03 commit 9a019ff

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ git hooks.
44
It does a few checks on source codes to ensure compliance with some general
55
CCDC coding standard.
66

7-
The commit will be flagged if it includes text files with:
7+
The commit will be flagged if it includes certain text files with:
88

9-
* File name that does meet Windows filename requirement
9+
* File name that can cause errors on Windows
1010
* CRLF line endings
1111
* NO NOT MERGE or DO NOT COMMIT
12-
* Trailing whitespaces
12+
* Trailing whitespace
1313
* Tabs
1414
* Missing terminating newline for certain files
1515
* Certain C++ #include patterns and std::exception
@@ -23,14 +23,21 @@ The commit will be flagged if it includes text files with:
2323
```
2424
2525
## Scenarios
26-
### Check files
26+
### Check files in pull request for merge to main
2727
```yaml
28+
name: Check pull request files
29+
on:
30+
pull_request
31+
branches: [ main ]
32+
jobs:
33+
Pull-request-files-check:
34+
runs-on: ubuntu-latest
35+
steps:
2836
- uses: actions/checkout@v2
2937
with:
3038
ref: ${{ github.head_ref }}
3139
fetch-depth: 0
32-
- id: check_files
33-
uses: ccdc-opensource/commit-hooks@v1
40+
- uses: ccdc-opensource/commit-hooks@v1
3441
```
3542
3643
# commit-hooks

0 commit comments

Comments
 (0)