Skip to content

Feature: Add automated version control scanner for reproducibility checklist (Statement 5) #466

Description

@Sumit-ai-dev

Prerequisites

  • Are you running the latest version?
  • Did you check other issues/PRs to see if this has already been reported or requested?

Current Behavior

In the Reproducibility Checklist tab, Statement 5 ("Version control of some kind is in place.") doesn't have an automated scanner hooked up in scanFunctions. The "StatWrap Defined Documentation" section stays completely blank, even when the project is an active Git repo.

Expected Behavior

  • Opening Statement 5 should automatically detect and display version control details under StatWrap Defined Documentation (just like Statements 1–4).
  • Exported PDF reports should include these findings as evidence.

Possible Solution

Add an automated scanner (ChecklistUtil.findVersionControl) and wire it into scanFunctions:

  • VCS Detection: Detects .git directories and submodule/worktree files (along with .hg and .svn).
  • Active Branch: Grabs the current branch from HEAD.
  • Latest Commit SHA: I think detecting the latest commit hash (e.g., Latest commit: 7d19ab6) would be a great addition here. Tying the checklist to the exact commit snapshot makes the exported report much more useful for reproducibility.
  • Safe fallback: Fails cleanly with empty results if folders are missing or unreadable.

I already have the scanner, UI integration, and full test coverage working locally.

I'd love your thoughts:

  • Does this look like a solid addition?
  • If so, I'd be happy to be assigned and open the PR!

Your Environment

  • Version used: 0.0.21 (Development branch)
  • Environment: macOS / Node.js

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    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