OpenParable
Skip to content
← Back to skills

Gf Review

Testing & Quality
gf-review

Gf Review is an Agent Skill for testing & quality published in the gogf/gf repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Code and specification review for OpenSpec workflow. Triggers automatically after /opsx:apply task completion, after /gf-feedback task completion, and before /opsx:archive. Use when user requests code review, spec compliance check, or when explicitly invoked via /gf-review.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/gogf/gf/blob/HEAD/.agents/skills/gf-review/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/gf-review, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

GF Review

Structured code and specification review for the OpenSpec development workflow.

Spec Source: CLAUDE.md is the single source of truth for all review criteria.


When This Skill Activates

Automatic triggers:

  • After completing each task in /opsx:apply
  • After completing each task in /gf-feedback
  • Before executing /opsx:archive

Manual trigger:

  • User explicitly requests: "review this code", "check spec compliance", "/gf-review"

Review Workflow

1. Identify Scope

Determine what needs to be reviewed:

  1. After task completion — Review files modified/created by the completed task
  2. Before archive — Review all changes in the current OpenSpec change
  3. Manual invocation — Ask user to specify scope or use current change

Mandatory scope collection rules:

  1. Start with repository status, not git diff alone:
    git status --short
    git ls-files --others --exclude-standard
    
  2. Treat all tracked and untracked changes as review candidates, including:
    • staged files
    • unstaged files
    • untracked files shown as ??
    • untracked directories shown as ?? path/
  3. When git status --short reports an untracked directory, expand it to concrete files before review:
    find <path> -type f
    # Or prefer:
    rg --files <path>
    
  4. If the task ran generators such as make ctrl, make dao, codegen scripts, or produced new test files, explicitly include the generated untracked files in review scope even if they do not appear in git diff.
  5. git diff may be used only as a secondary narrowing aid after status collection. It is never sufficient by itself for review scope definition.

Run openspec status --change "<name>" --json to understand the current change state.

2. Load Specifications

Read CLAUDE.md to load all specifications. This is the single source of truth.

3. Backend Code Review

Trigger: Changes to files under apps/lina-core directory

  1. Invoke goframe-v2 skill for GoFrame framework conventions
  2. Check against CLAUDE.md backend code specifications

4. RESTful API Review

Trigger: Any API endpoint changes

Check against CLAUDE.md API design specifications.

5. Project Specification Review

Trigger: Any implementation changes

Check against CLAUDE.md architecture design specifications and code development specifications.

6. SQL Review

Trigger: New or modified files under apps/lina-core/manifest/sql/、apps/lina-core/manifest/sql/mock-data/、apps/lina-plugins/**/manifest/sql/ or SQL snippets embedded in related delivery docs

Check against CLAUDE.md SQL file management specifications, at minimum covering:

  1. File naming, versioning, and single-iteration single-file rules
  2. Seed DML vs mock data separation
  3. Idempotent execution safety — SQL must be safe to run multiple times without duplicate-object errors or duplicate seed data; verify use of IF [NOT] EXISTS, IF EXISTS, INSERT IGNORE, or equivalent safe re-entry patterns
  4. Seed write style compliance — delivered SQL must reject INSERT ... ON DUPLICATE KEY UPDATE and reject explicit writes to AUTO_INCREMENT id columns in seed/mock/install data
  5. Whether schema/data changes still match the current change scope and deployment path

7. Unit Test Review

Trigger: New or modified Go implementation files, or new/modified Go unit test files matching *_test.go

Check at minimum:

  1. Behavior-changing Go code includes focused unit coverage in the same package, preferably by extending existing *_z_unit*_test.go or *_test.go
  2. Tests assert the changed logic directly instead of relying on broad workflow-level coverage when a package-level test is sufficient
  3. Verification uses targeted go test ./path/to/pkg -run TestName during development and package-level go test ./path/to/pkg for regression

8. Generate Review Report

## GF Review Report

**Change:** <change-name>
**Scope:** <task-specific / full change>
**Files Reviewed:** <count>
**Scope Source:** `git status --short` + `git ls-files --others --exclude-standard` + task/change context

### Backend Code Review
✓ All checks passed / ⚠ N issues found

### RESTful API Review
✓ All endpoints compliant / ⚠ N violations found

### Project Spec Review
✓ Compliant with CLAUDE.md / ⚠ N violations found

### SQL Review
✓ No SQL changes / ✓ SQL changes compliant / ⚠ N SQL issues found

### Unit Test Review
✓ Unit tests are focused and sufficient / ⚠ N issues found

### Summary
- **Critical:** N (must fix before archive)
- **Warnings:** N (recommended to fix)

### Recommended Actions
1. [Specific action with CLAUDE.md reference]

Issue Severity

LevelBehavior
CriticalBlock archive, must fix
WarningShow but allow proceed

Integration Points

Workflow StepBehavior
/opsx:apply task doneReview, offer to fix issues before next task
/gf-feedback task doneReview, fix before marking complete
/opsx:archiveReview all changes, block on critical issues

Guardrails

  • CLAUDE.md is the single source of truth — All spec references point to it
  • Only check categories relevant to changed files
  • Scope identification MUST include untracked files and expanded untracked directories; never rely on git diff alone
  • Behavior-changing Go code without focused unit tests is a review finding unless the author documents why tests are not applicable
  • Don't block on warnings — only critical issues block archive
  • Include file paths and line numbers in issue reports
  • Offer to fix issues automatically when straightforward