skills.rest
QSD-Group
QSD-GroupOFFICIAL
Explore all skills by this author →
GitHub

qsdsan-pr-audit

Audit QSDsan pull requests against the canonical PR audit checklist.

43|28|Updated Sep 29, 2020
Search Tags:#code review#pull request#github#bioSTEAM#thermosteam#unit registry#stream taxonomy
One-click install
npx skills add https://github.com/QSD-Group/QSDsan --skill qsdsan-pr-audit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: qsdsan-pr-audit
Source: https://github.com/QSD-Group/QSDsan/tree/main/.claude/skills/qsdsan-pr-audit
Command: npx skills add https://github.com/QSD-Group/QSDsan --skill qsdsan-pr-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Prevents regressions and integration mistakes when QSDsan pull requests modify BioSTEAM/Thermosteam import boundaries, stream/unit APIs, or unit registries by aligning reviews with the repository's canonical PR audit checklist.

Core Features & Use Cases

  • Checklist-driven PR review: Guides reviewers to follow the authoritative checklist for QSDsan conventions covering Stream, SanStream, WasteStream, and SanUnit.
  • Import boundary and API validation: Helps ensure contributor changes correctly respect BioSTEAM/Thermosteam import rules and stream/unit API expectations.
  • Consistent review output: Produces structured, review-ready outputs that match the expected format and focuses on relevant tests.

Quick Start

Use qsdsan-pr-audit to review the PR at hand by comparing its changes against docs/maintainer/pr_audit_checklist.md as the source of truth.

Frequently Asked Questions about qsdsan-pr-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a QSDsan pull request for BioSTEAM and Thermosteam import changes?▼

To review a QSDsan pull request, audit the code changes against the canonical checklist in docs/maintainer/pr_audit_checklist.md to validate BioSTEAM and Thermosteam import boundaries, stream and unit APIs, and unit registries.

What is a stream and unit API audit for QSDsan PRs?▼

A stream and unit API audit checks whether pull request changes correctly respect QSDsan conventions for Stream, SanStream, WasteStream, and SanUnit, preventing integration mistakes and regressions when BioSTEAM or Thermosteam imports are modified.

When do I need to run a PR audit checklist on QSDsan contributions?▼

You need to run a PR audit checklist when a QSDsan pull request touches Stream, SanStream, WasteStream, or SanUnit conventions, or modifies BioSTEAM and Thermosteam import boundaries, stream taxonomy, and unit registries.

How to format QSDsan code review outputs for stream and unit registry validation?▼

Format QSDsan code review outputs by following the canonical pr_audit_checklist.md rules, which produce structured, review-ready results that match the expected format and focus on selecting relevant tests for the changed stream and unit APIs.

Does this PR audit work with SanStream and WasteStream taxonomy changes?▼

Yes, this PR audit works with SanStream and WasteStream taxonomy changes by applying the repository's canonical checklist rules to verify that stream taxonomy and unit registry modifications align with QSDsan conventions and prevent regressions.

What are the limitations of auditing QSDsan pull requests for API correctness?▼

Auditing QSDsan pull requests is limited to checking BioSTEAM and Thermosteam import boundaries, stream and unit APIs, registries, and documentation, requiring the canonical checklist as the source of truth rather than providing generalized code review.

Related Skills

Explore More Software Engineering Skills→
QSD-GroupQSD-Group
43

qsdsan-exposan-architecture

Guide architecture-level modifications across QSDsan and EXPOsan repositories.

Official
Advanced
mattphanmmattphanm

code-review

Identify and report code-quality, style, and maintainability issues in code changes.

Community
Advanced
WellApp-aiWellApp-ai
341

code-review

Detect hard-rule violations and quality issues in JavaScript/TypeScript code changes.

Official
Intermediate
wade56754wade56754

ai-ad-code-verifier

Verify ad-code integration for cross-module boundary and API violations.

Community
Advanced