Skip to content

Commit 52b8490

Browse files
authored
docs: add screenshot to README.md (#9)
1 parent 42c1fa3 commit 52b8490

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,18 @@ jobs:
6868

6969
Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml), if you want to customize just add your `.commit-check.yml` config file under your repository root directory.
7070

71+
## GitHub Actions job summary
72+
73+
By default, commit-check-action results are shown on the job summary page of the workflow.
74+
75+
### Success summary
76+
77+
![Success summary](https://github.com/commit-check/.github/blob/main/screenshot/success-summary.png)
78+
79+
### Failure summary
80+
81+
![Failure summary](https://github.com/commit-check/.github/blob/main/screenshot/failure-summary.png)
82+
7183
## Badging your repository
7284

7385
You can add a badge to your repository to show your contributors / users that you use commit-check!

0 commit comments

Comments
 (0)