Skip to content

feat: host the README badge at commit-check.com/badge.svg #46

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
shenxianpeng merged 1 commit into from
Sep 27, 2026
Merged

feat: host the README badge at commit-check.com/badge.svg #46

Show file tree
Hide file tree
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
51 changes: 51 additions & 0 deletions docs/badge.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,27 @@ a release artifact came from this repository's build pipeline:
$ gh attestation verify commit_check-*.whl --repo commit-check/commit-check
```

## Show that you use it

Put the badge in your README, so contributors know their commits will be
checked before they open a pull request:

[![commit-check](badge.svg)](https://commit-check.com)

=== "Markdown"

```markdown
[![commit-check](https://commit-check.com/badge.svg)](https://commit-check.com)
```

=== "reStructuredText"

```rst
.. image:: https://commit-check.com/badge.svg
:target: https://commit-check.com
:alt: commit-check
```

## Where to go next

- **[Where to run it](guides/integrations.md)** — pre-commit hook, GitHub
Expand Down