cli: make `chock check` say what to do next when it fails

Open Beginner friendly
  • Is something wrong?
#133 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
85/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
cli

Research direction

Start in src/chock/ to locate each check that raises a failure message. For each check, append a context-specific next action (regeneration command, relevant file, or doc section) to the existing error text, following the constraints to avoid incorrect suggestions or changes to check logic. Run chock check against scenarios that trigger each failure to confirm the new guidance is accurate and no check behavior is altered.

Written by the indexing model from the issue text.

Description

good first issue help wanted

chock check is the command a new adopter runs first, and its failure output currently names
what is wrong without naming the fix. For someone who has just installed chock, "compiled drift"
or "vendored-runtime-modified" is a diagnosis in a language they do not speak yet.

What to do: for each check that can fail, add the next action to the failure message — the
command that regenerates, the file to look at, or the doc section that explains it. The message
stays beside the condition that raises it; do not move diagnostics into a lookup table.

Constraints:

  • Do not weaken any check to make its message nicer, and do not make a failing check exit zero.
    This is about the text, not the verdict.
  • Do not suggest a fix that is wrong for the situation. "Run chock sync" is unhelpful if the
    drift came from an upstream version bump — say which case is which, or say nothing.

Good first issue for someone who wants to learn the codebase by reading its error paths, which is
usually the fastest way in. Sized to an afternoon. Files: src/chock/, wherever each check
raises.

Dominant language
Python
Stars
8
Forks
1
Avg merge
6h 34m
Merged PRs (30d)
145

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from open-coder-ai/chock

All issues in open-coder-ai/chock

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.