Skip to content

docs: add screenshot to README.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 3, 2023
Merged

docs: add screenshot to README.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,18 @@ jobs:

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.

## GitHub Actions job summary

By default, commit-check-action results are shown on the job summary page of the workflow.

### Success summary

![Success summary](https://github.com/commit-check/.github/blob/main/screenshot/success-summary.png)

### Failure summary

![Failure summary](https://github.com/commit-check/.github/blob/main/screenshot/failure-summary.png)

## Badging your repository

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