Skip to content
ghqc

Introduction to ghqc

This section will start with an introduction to the core utilities and motivation of the ghqc ecosystem, walk through an accelerated set-up, then walk through your first QC using ghqc.

Background

Section titled “Background”

ghqc utilizes GitHub Issues and Milestones as the nexus for the QC process.

  • GitHub Issue - Files assigned for QC are tracked as GitHub Issues to track findings, discourse, and resolution all in the same place.
  • GitHub Milestones - Related Issues are tracked as GitHub Milestones to track common goals or project phases.

ghqc utilizes an iterative 3 phase approach for each file to be QCed:

  1. Initialize - A QC is initialized upon the creation of a GitHub Issue through the ghqc assign app. It contains metadata around the file at initialization and checklist items which the QCer should review the file for.
  2. Review - After initialization, review occurs. ghqc promotes an iterative and interactive method by allowing the QCers to comment within the Issue and the author to reply back with a file difference, highlighting the changes, using the ghqc notify app.
  3. Approval - After the QCer has reviewed the file and has all of their feedback addressed, the Issue can be approved and closed through the ghqc status app.

ghqc utilizes GitHub as its hub for QC as it centralizes the files and the traceability of the files in one, easily accessible, persistent location. In addition to the GitHub Issue storing the history of the QC, ghqc can create a pdf report of the QC to record the QC process.

Prerequisites

Section titled “Prerequisites”

The following are required to launch the ghqc apps:

  1. You are running R in an RStudio session
  2. You have a .Rproj open
  3. The directory is the root of a GitHub repository