Repository navigation
docs(review): checklist of patterns that hide a defect, from SlopCodeBench's rubric - #731
Conversation
…Bench's rubric Signed-off-by: Petrov, Nikolay A <nikolay.a.petrov@intel.com>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the documentation-only guidance update.
No open issues 🎉
What changed in this PR
0 new findings; nothing to fix.
This documentation-only PR expands dokimi’s review guidance with 11 checklist items adapted from SlopCodeBench’s rubric, focusing on patterns that can hide defects.
Changes:
- Adds checks for hidden failures, lost data, unnecessary abstractions, and misleading documentation.
- Defines these patterns as must-fix when they change a number, verdict, or exit code; otherwise, as nits.
- Leaves runtime behavior and CI checks unchanged.
| File | Description |
|---|---|
REVIEW.md |
Adds the “Patterns that hide a defect” checklist and its severity rule. |
Review effort: Balanced
|
✅ OpenCodeReview: Review complete: 0 finding(s) across 1 selected item(s). CI at Review details
|
Style-point bullets are raised only when they change a number, verdict or exit code; a finding that matches a listed defect keeps that severity. Signed-off-by: vchamarthi <123653452+vchamarthi@users.noreply.github.com>
|
Pushed 1 commit to
|
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #731 +/- ##
=======================================
Coverage 95.73% 95.73%
=======================================
Files 404 405 +1
Lines 54139 54211 +72
Branches 9317 9325 +8
=======================================
+ Hits 51829 51899 +70
- Misses 1424 1427 +3
+ Partials 886 885 -1 🚀 New features to boost your workflow:
|
xaleryb
left a comment
There was a problem hiding this comment.
Re-checked on the head merged with main: the docs tests pass (81), the docs-review trigger reports no affected page, and the REVIEW.md rules are consistent with the existing ones. Static checks is green after the update with main; the PR's own diff is unchanged.
Adds a "Patterns that hide a defect" checklist to
REVIEW.md: the reviewer-judgement items of SlopCodeBench's 45-item LLM-judge rubric (configs/rubrics/llm_judge.jsonl, https://github.com/SprocketLab/slop-code-bench) that apply to dokimi, merged into 11 bullets. Items an existing gate covers, and items that do not fit a sync Python CLI, are left out.Severity rule in the new section: must-fix when the pattern changes a number, verdict or exit code (matching "What a defect looks like here"), otherwise a nit.
Mapping
Gate = already enforced in CI. Mech = a cheap mechanical check is possible (follow-up below). Review = added to REVIEW.md. Skip = does not fit dokimi.
check_comment_blocks.py(≤2 lines). Review bullet for 1-2 line narration. Mech F3LOG/Gcover logger misuseB019covers the harmfullru_cachecase; the rest is perf stylewarn_unreachableflagsis Noneon non-Optional. Review for the restNone-on-never-Nonebullet)ASYNCcovers misusecheck_growth.pylimits it; otherwise skipFalse,None...")E722gates a bare except; open #729 addsBLE001/S110/S112for blind and silent exceptschema_compatandtest_records_guard.pycheck_untyped_defs,no_implicit_optional,strict_equality)pathlib... already does"); ruffPIE/PLWcover a fewordefault bullet). Mech F7EnumorLiteral")PLW1510(subprocesscheck=) is deferred in pyproject. Mech F1audit_test_quality.pygates the test-side version (asserts nothing, echoes input)Follow-ups (cheap mechanical checks, not implemented here)
PLW1510(subprocess.runwithoutcheck=), so each call says whether a failure is checked. Covers feat(repo): repo compare, treatment arms against a baseline arm paired by task #42.raise NotImplementedError,pass # TODO,return None # placeholderoutside abstract methods. Covers refactor(gate): merge soft_gate and hard_gate into one score_gate #22, fix(ci-local): match the intel/dokimi remote by the URL git fetches from #21.check_comment_blocks.pyto flag added comments startingStep N:,First,,Now we,Next,. Covers Make dokimi public #1._). Covers Make dokimi public #2.ABC/Protocolsubclass with exactly one concrete subclass indokimi/. Covers docs: generate the documentation site and publish it to GitHub Pages #6, fix(novelty): stop failed judge/oracle replies from reading as verdicts #7, fix(cli): offer only the judge providers the Judge accepts #11.mkdir(parents=True, exist_ok=True)/os.makedirs(..., exist_ok=True)sites on read paths for review. Covers ci: run CodeQL from a workflow so PRs from forks are scanned #18 (noisy; likely advisory only).warn_unreachableandstrict_equality, which flag anis Nonebranch on a non-Optional type; it does not flagx or default. A small AST check fororon a parameter typed non-Optional, non-bool would cover docs: open PRs from a fork, based on main; ci-local finds the intel/dokimi remote #16, fix(novelty): rows that are not atoms, verdicts that are not booleans, and self-conflicts no longer read as results #40.Testing
Docs-only change to
REVIEW.md; no code path changes.make ci-localstatic job (license header, docs refs) is the relevant check.🤖 Generated with Claude Code