Package 'ghqc.app'

Title: Create QC Checklists in Github Issues
Description: A QC tool with 3 major functions: creation and management of QC log, creation and management of QC record, perform semi-automated QC tasks.
Authors: Jenna Johnson [aut, cre], Anne Zheng [aut], Janelle Lennie [ctb], Devin Pastoor [aut], Wes Cummings [aut]
Maintainer: Jenna Johnson <[email protected]>
License: GPL (>= 3)
Version: 0.1.1
Built: 2024-10-29 20:17:12 UTC
Source: https://github.com/a2-ai/ghqc.app

Help Index


Assign file(s) for QC

Description

This function provides an interface to assign one or more files for QC in the form of a GitHub Issue(s) within a GitHub Milestone, with options to assign a repository collaborator as the QCer and/or generate a checklist of suggested review tasks during QC.

Usage

ghqc_assign_app()

Value

Starts a Shiny app and does not return any value.


Generate a QC Record for one or more Milestones

Description

This function allows the user to generate a QC Record for one or more Milestones created with the assign app.

Usage

ghqc_record_app()

Value

Starts a Shiny app and does not return any value.


Comment in an Issue to display file changes during QC

Description

This function allows a user to insert a comment into a ghqc GitHub Issue that displays changes in the version control information for the Issue’s corresponding file. By default, the comment displays both the original and current commits and hashes for the file. These versions are selected by the user. The comment can optionally display the file difference (“diff”) between the current and previous versions. These changes will likely be implementations of QC feedback.

Usage

ghqc_resolve_app()

Value

Starts a Shiny app and does not return any value.


set the repo that stores the ghqc info

Description

set the repo that stores the ghqc info

Usage

ghqc_set_info_repo(
  repo_path = file.path("~/.local/share/ghqc", info_repo_name())
)

Arguments

repo_path

path to the git repo storing ghqc information