The README documents only the three original mining scripts and still describes the project as the 2025 GSTEM study. It does not mention analysis/inspect_commit.py, the candidate set at data/message_refactoring_candidates.csv, or how the LFS and Xet fetch paths behave, so a new contributor cannot get from a clone to an inspected commit without asking.
Much of what makes the inspection path work is currently unwritten, and it took several rounds to get right. That knowledge should live in the repo rather than in anyones head.
What to cover
Provenance section
Update it so the current state of the project is represented, rather than only the 2025 preliminary study. The classifier spec lives in #11.
The README documents only the three original mining scripts and still describes the project as the 2025 GSTEM study. It does not mention
analysis/inspect_commit.py, the candidate set atdata/message_refactoring_candidates.csv, or how the LFS and Xet fetch paths behave, so a new contributor cannot get from a clone to an inspected commit without asking.Much of what makes the inspection path work is currently unwritten, and it took several rounds to get right. That knowledge should live in the repo rather than in anyones head.
What to cover
analysis/inspect_commit.pydoes, and its flags.--downloadis required, and what it actually fetches (the header row rather than the whole file).--show_rowsis needed, and why a column-set diff alone is insufficient for a values-only change. See --show_rows diffs the local LFS pointer instead of the downloaded content #52.Provenance section
Update it so the current state of the project is represented, rather than only the 2025 preliminary study. The classifier spec lives in #11.