commit_check/util.py (1)

258-259: Consider a fallback message when error is empty.

Right now, if error is blank, users lose the expected constraint context even though regex is available.

Proposed refinement

-    if error:
-        print(error)
+    if error:
+        print(error)
+    elif regex:
+        print(f"Expected constraint: {regex}")

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@commit_check/util.py` around lines 258 - 259, The current print branch only
emits error when the variable error is truthy, so callers lose context if error
is empty; update the logic around the if error: print(error) block in
commit_check/util.py (the variables error and regex) to print a fallback message
when error is falsy—e.g., print a concise constraint hint that includes the
regex value or a default string like "constraint not met: expected pattern
{regex}"—so users always see either the specific error or the regex-based
constraint context.

CONTRIBUTING.md (1)

98-151: Add a manual validation checklist to contributor workflow.

Given this project’s validator breadth, a short manual test checklist in this section would reduce regressions.

Based on learnings: Test validation scenarios manually after changes including valid commits, invalid formats, complex commits, branch names, help/version, and configuration validation.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 98 - 151, Add a short manual validation
checklist to the contributor workflow in CONTRIBUTING.md under the
pre-commit/testing section: create a "Manual validation checklist" paragraph
after the "Test the pre-commit hook on GitHub" block that lists concrete manual
test scenarios to run (e.g., validate a valid commit message, test
invalid/edge-case commit formats, multi-line/complex commits, branch-name
checks, check help/version output for check-message and check-branch, and run
configuration validation), and include the exact commands shown (pre-commit
try-repo, commit-check -m, pytest/nox/lint commands) as examples so contributors
can reproduce each step easily.

tests/util_test.py (1)

323-331: Missing assertion for reason parameter in test.

The test passes dummy_reason to print_error_message but doesn't assert that it appears in stdout. Since reason is printed in the output (check failed ==> {reason}), adding this assertion would improve test coverage.

🧪 Suggested fix to add missing assertion

         def test_print_error_message(self, capfd, check_type, type_failed_msg):
             # Must print on stdout with given argument.
             dummy_reason = "failure reason"
             dummy_error = "dummy error"
             print_error_message(check_type, dummy_error, dummy_reason)
             stdout, _ = capfd.readouterr()
             assert check_type in stdout
             assert type_failed_msg in stdout
             assert dummy_error in stdout
+            assert dummy_reason in stdout

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@tests/util_test.py` around lines 323 - 331, The test test_print_error_message
currently calls print_error_message(check_type, dummy_error, dummy_reason) but
never asserts that the reason appears in output; update the
test_print_error_message to assert that dummy_reason is present in stdout (e.g.,
assert dummy_reason in stdout) so the printed "check failed ==> {reason}" is
verified; locate this in the test function using the test_print_error_message
name and the dummy_reason variable.

commit_check/util.py (1)

35-41: Unused regex parameter in _print_failure.

The regex parameter is still accepted for backward compatibility with callers like engine.py (which passes constraint), but it's no longer used or passed downstream. Consider documenting this in the docstring, or if the callers can be updated, removing the parameter entirely to avoid confusion.

📝 Suggested documentation update

 def _print_failure(check: dict, regex: str, actual: str) -> None:
-    """Print a standardized failure message."""
+    """Print a standardized failure message.
+    
+    Note: The `regex` parameter is retained for API compatibility but is no longer displayed.
+    """
     if not print_error_header.has_been_called:
         print_error_header()
     print_error_message(check["check"], check.get("error", ""), actual)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@commit_check/util.py` around lines 35 - 41, The `_print_failure` function
currently accepts an unused `regex` parameter; update the function to either
remove the `regex` parameter from `_print_failure` (and update callers like
`engine.py`) or, if you must keep it for backward compatibility, amend the
`_print_failure` docstring to explicitly state that `regex`/`constraint` is
accepted but ignored and kept only for compatibility; locate `_print_failure`
and adjust its signature or docstring accordingly and ensure calls to
`print_error_header`, `print_error_message`, and `print_suggestion` (and the
`print_error_header.has_been_called` check) remain unchanged.

CONTRIBUTING.md (1)

23-40: ⚠️ Potential issue | 🟡 Minor

Add language tags to fenced architecture/code-tree blocks.

Line 23, Line 44, and Line 59 still use unlabeled triple-backtick fences, which triggers MD040.

Proposed fix

-```
+```text
 CLI args / Env vars / TOML file
@@
-```
+```

-```
+```text
 commit_check/
@@
-```
+```

-```
+```text
 BaseValidator (ABC)
@@
-```
+```

Also applies to: 44-55, 59-72

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 23 - 40, Several fenced code/diagram blocks in
CONTRIBUTING.md (the ASCII diagrams and the commit_check/ and BaseValidator
blocks) lack language labels, triggering MD040; add a language tag (use "text")
to each unlabeled triple-backtick fence around the diagrams and code-tree blocks
(the blocks containing "CLI args / Env vars / TOML file → ConfigMerger →
RuleBuilder → ValidationEngine → BaseValidator subclasses", the "commit_check/"
block, and the "BaseValidator (ABC)" block) so each opening fence becomes
```text and the closing fences remain ``` to satisfy the markdown linter.