feat(buglog): one Markdown record per bug, checked against a record standard
The buglog was one 27K-line JSON file whose fields covered only symptom,
root cause and fix, as free text: 2% of entries named the code version a
bug was found on, 12% the build profile, 36% a way to reproduce, and 58% of
the file was OpenWolf hook auto-detections ("Missing guard clause",
"Function not marked async" on .md files).
- .claude/skills/buglog/bug-record.md: the record standard. Eight
sections (Summary as the title, Description, Environment, Reproduction;
Root cause, Fix, Verification, References once fixed), each with the
content it must contain -- e.g. Environment needs the OS, the libc the
failing binary loads (from its ELF interpreter: glibc 2.42 in the nix
shell vs 2.40 on the host), toolchain, build profile and commit.
- .wolf/bugs/<id>.md: 500 records migrated from buglog.json; every field
verified to round-trip. They carry legacy: true and an explicit "not
recorded" where the old log had no such field; component derived from
file paths, severity from keywords (else unknown), fix_commits from
hashes in status_note/fix that git resolves (91 of 463 fixed).
- .wolf/buglog-archive.json: the 710 hook auto-detections, verbatim.
- .wolf/buglog.json is now an index generated from the records, keeping
the fields OpenWolf's hooks and `openwolf bug search` read.
- scripts/buglog.py rewritten: new (template + Environment collected from
the machine and --binary), check, status (refuses a status the record
doesn't support; fixed needs Root cause, Fix, Verification and
--commit hashes git resolves), note, recur, set, show, list, triage,
env, index. 29 unittest cases in scripts/tests/test_buglog.py.
- scripts/git-hooks/pre-commit runs `check --staged`: incomplete staged
records, a legacy record hand-changed to fixed without the fix-time
sections, a new record claiming legacy: true, or a stale index refuse
the commit.
- scripts/gitea-sync.py reads the records: issue body = the record's
sections plus linked fix commits (origin remote, GITEA_COMMIT_REPO to
override), and a body hash so an issue's text is refreshed when the
record changes.
- bug-1866 rewritten to the full standard as the worked example.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
27b7a84980
commit
d26ff8870d
512 changed files with 40724 additions and 17843 deletions
|
|
@ -1,34 +1,34 @@
|
|||
# Buglog status field
|
||||
# Bug records and their status
|
||||
|
||||
Kept separate from `openwolf.md` because `openwolf update` overwrites that file.
|
||||
OpenWolf itself ignores this field (search, pre-write hints and the hook-created
|
||||
entries don't read or set it), so the convention is enforced only by this rule.
|
||||
|
||||
- Every `.wolf/buglog.json` entry carries a `status`, and it is the only source
|
||||
of truth for whether a bug is open. Never infer it from `fix`: many entries
|
||||
have a populated `fix` that says "NOT FIXED", "PENDING" or "PARTIAL".
|
||||
- Each bug is a Markdown record, `.wolf/bugs/<id>.md`, written to the standard
|
||||
in `.claude/skills/buglog/bug-record.md` (what Description, Environment,
|
||||
Reproduction, Root cause, Fix and Verification must contain). Create and
|
||||
change records with the `buglog` skill (`scripts/buglog.py`), which checks
|
||||
them against that standard.
|
||||
- `.wolf/buglog.json` is an index generated from the records; never edit it.
|
||||
`.wolf/buglog-archive.json` holds retired OpenWolf hook auto-detections.
|
||||
- The front-matter `status` is the only source of truth for whether a bug is
|
||||
open. Never infer it from the Fix text or tags: migrated records often
|
||||
quote "NOT FIXED" or "PENDING" from earlier stages.
|
||||
- Values:
|
||||
- `open`: defect confirmed and still in the code. Intermittent test
|
||||
failures that do still recur count as `open`, not `cannot-reproduce`.
|
||||
- `partial`: part fixed; `status_note` says what remains.
|
||||
- `investigating`: real failure observed, root cause not found yet or
|
||||
waiting for a reproduction.
|
||||
- `fixed`: fix committed; cite the commit in `fix` or `status_note`.
|
||||
- `fixed`: fix committed; `fix_commits` lists the commit(s) and the
|
||||
Verification section says how the fix was proven.
|
||||
- `cannot-reproduce`: reproduction was attempted and failed; record what was
|
||||
tried in `repro_attempts` (e.g. "0/40 runs, 2026-08-01").
|
||||
- `wontfix`: not a bug, accepted limitation, or deferred with no plan.
|
||||
- `duplicate`: same defect as another entry; set `duplicate_of`.
|
||||
- Whenever you log a bug or change its state, set `status` and
|
||||
`status_updated` (YYYY-MM-DD), plus `status_note` unless the status is
|
||||
`fixed` with the commit already in `fix`. Put them right after `"id"`.
|
||||
- A `cannot-reproduce` bug that recurs: bump `occurrences`/`last_seen` and set
|
||||
`status` back to `investigating`.
|
||||
- Use the `buglog` skill (`scripts/buglog.py`) to add entries and change
|
||||
status: `add`, `status`, `note`, `recur`, `list`, `triage`. It picks the
|
||||
next free id and edits only the touched entry's lines. Don't re-serialize
|
||||
the whole file with `json.dumps`/`jq`; that rewrites ~1,200 unrelated lines.
|
||||
- Open-bug list:
|
||||
- `duplicate`: same defect as another record; set `duplicate_of`.
|
||||
- Change status only with `python3 scripts/buglog.py status <id> <status>`
|
||||
(`--note` for every status except `fixed`; `--commit <sha>` for `fixed`).
|
||||
It sets `status_updated` and refuses a change the record doesn't support.
|
||||
- A `cannot-reproduce` bug that recurs: `buglog.py recur <id>` bumps
|
||||
`occurrences`/`last_seen` and sets `status` back to `investigating`.
|
||||
- Open-bug list: `python3 scripts/buglog.py list --open`, or from the index:
|
||||
`jq -r '.bugs[] | select(.status | IN("open","partial","investigating")) | "\(.id) [\(.status)] \(.status_note // .error_message[0:90])"' .wolf/buglog.json`
|
||||
- Entries with no `status` (hand-written without it, or created by an OpenWolf
|
||||
hook) need triage:
|
||||
`jq -r '.bugs[] | select(.status == null) | .id' .wolf/buglog.json`
|
||||
- Records with no valid status need triage: `python3 scripts/buglog.py triage`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue