From cb4733eee83d855b976a5b36d71fe59c354d7c57 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Fri, 3 Feb 2023 11:38:24 +0800 Subject: [PATCH] docs: add screenshot to README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 0eb34c8..f8018fb 100644 --- a/README.md +++ b/README.md @@ -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!