okl reverify re-stamps a doc or comment edit that its check doesn't test

Open
#217 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
cli

Research direction

Start from the okl reverify command and the code path that stamps a lesson when its stored check passes, including how --yes skips confirmation. The payload names no files, so locate them first. Done means that a drifted lesson with a changed doc file shows the diff since the verified commit and asks before stamping, even with --yes, unless a flag says the diff was read. Decide the comment-only edit case with a maintainer before coding.

Written by the indexing model from the issue text.

Description

okl reverify stamps whenever the stored check passes, and it never shows what changed. In the trial, two edits got fresh stamps because the check tested neither:

  • an ADR edit that renamed every error code;
  • a code comment that had been made false.

So a lesson that governs a doc reads as proven after its doc changed meaning.

Proposal: when a drifted lesson's changed files include a doc (.md, .rst, .adoc, .txt), okl reverify prints the diff since the verified commit and asks before stamping, even with --yes, unless a flag says the diff was read. Consider the same for comment-only edits.

Found by the #207 audit (a docs audit, a code audit, a newcomer read and an end-to-end trial on okl 0.8.7, each finding adversarially verified). Part of #207.

Dominant language
Python
Stars
1
Forks
1
Avg merge
5h 22m
Merged PRs (30d)
119

Getting set up

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 emeraldleaf/okl

All issues in emeraldleaf/okl

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.