Skip to content

docs(site): update hero error examples to match current output #101

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
benner merged 2 commits into from
May 6, 2026
Merged

docs(site): update hero error examples to match current output #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8fcca0
docs(site): update hero error examples to match current output
benner May 6, 2026
a84d2fb
docs: refresh README example output with the signed-off hint
benner May 6, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Opinionated conventional commit message linter with imperative mood detection.
```bash
$ commit-guard
✗ [subject] subject does not match 'type(scope): description': WIP
✗ [signed-off] missing 'Signed-off-by' trailer
✗ [signed-off] missing 'Signed-off-by' trailer — use 'git commit -s'
✗ [signature] commit is not signed (GPG/SSH)
```

Expand Down
22 changes: 10 additions & 12 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
.hero-terminal pre {
margin: 0;
font-size: 0.95rem;
width: 64ch;
width: 80ch;
height: 12em;
overflow: hidden;
}
Expand Down Expand Up @@ -291,12 +291,10 @@
<h1>commit-guard</h1>
<p>Conventional commit linting with imperative mood detection.</p>
<div class="hero-terminal">
<pre><code id="hero-code">$ commit-guard --range origin/main..HEAD
<span class="c-dim">abc1234</span> feat: add user authentication
<span class="c-green">✓</span> all checks passed
<span class="c-dim">def5678</span> wip: still working
<span class="c-red">✗</span> <span class="c-dim">[subject]</span> unknown type: wip
<span class="c-red">✗</span> <span class="c-dim">[body]</span> missing body</code></pre>
<pre><code id="hero-code">$ commit-guard
<span class="c-red">✗</span> <span class="c-dim">[subject]</span> subject does not match 'type(scope): description': WIP
<span class="c-red">✗</span> <span class="c-dim">[signed-off]</span> missing 'Signed-off-by' trailer — use 'git commit -s'
<span class="c-red">✗</span> <span class="c-dim">[signature]</span> commit is not signed (GPG/SSH)</code></pre>
</div>
<div class="hero-dots">
<button class="hero-dot" data-i="0"></button>
Expand Down Expand Up @@ -618,16 +616,16 @@ <h2>pre-commit <a href="#pre-commit" class="anchor">#</a></h2>
const EXAMPLES = [
[
["$ commit-guard\n ", null],
["✗", "c-red"], [" [subject]", "c-dim"], [" unknown type: wip\n ", null],
["✗", "c-red"], [" [body]", "c-dim"], [" missing body\n ", null],
["✗", "c-red"], [" [imperative]", "c-dim"], [" got 'added', want imperative verb", null],
["✗", "c-red"], [" [subject]", "c-dim"], [" subject does not match 'type(scope): description': WIP\n ", null],
["✗", "c-red"], [" [signed-off]", "c-dim"], [" missing 'Signed-off-by' trailer — use 'git commit -s'\n ", null],
["✗", "c-red"], [" [signature]", "c-dim"], [" commit is not signed (GPG/SSH)", null],
],
[
["$ commit-guard --range origin/main..HEAD\n", null],
["abc1234", "c-dim"], [" feat: add user authentication\n ", null],
["✓", "c-green"], [" all checks passed\n", null],
["def5678", "c-dim"], [" wip: still working\n ", null],
["✗", "c-red"], [" [subject]", "c-dim"], [" unknown type: wip\n ", null],
["def5678", "c-dim"], [" chore: added logging\n ", null],
["✗", "c-red"], [" [imperative]", "c-dim"], [" expected imperative verb, got 'added' (non-imperative suffix)\n ", null],
["✗", "c-red"], [" [body]", "c-dim"], [" missing body", null],
],
[
Expand Down
Loading