Skip to content

Document the mining pipeline and the LFS/Xet fetch paths #70

Description

@khatchad

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.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions