code-change-verification

Run formatting, linting, type checking, and unit tests via make targets.

6|2|Updated Aug 22, 2024
One-click install
npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill code-change-verification-nq-lovecpp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-change-verification
Source: https://github.com/NQ-lovecpp/cpp_chatsystem/tree/main/ChatSystem-Backend/8.Agent_Server/examples/openai-agents-python-main/.agents/skills/code-change-verification
Command: npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill code-change-verification-nq-lovecpp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that all code changes are thoroughly verified for quality and correctness before being merged, preventing regressions and maintaining code health.

Core Features & Use Cases

  • Automated Checks: Runs formatting, linting, type checking, and tests.
  • Fail-Fast: Stops execution immediately if any check fails, highlighting the exact issue.
  • Use Case: Before submitting a pull request that modifies core application logic, use this Skill to automatically confirm that the code adheres to project standards and all tests pass.

Quick Start

Run the code-change-verification skill to ensure all code changes pass the mandatory verification stack.

Frequently Asked Questions about code-change-verification

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

FAQPage Schema
How do I automatically verify code changes before submitting a pull request?

Automated code verification executes a mandatory stack of formatting, linting, type checking, and unit tests to ensure changes adhere to project standards. It uses make targets to enforce strict, fail-fast execution, preventing regressions before merging.

What is a fail-fast verification stack for runtime code modifications?

A fail-fast verification stack immediately stops execution and highlights the exact issue if any check fails. It enforces a strict execution order for formatting, linting, type checking, and tests, ensuring code health and correctness.

How do I run linting and type checking for the OpenAI Agents Python repository?

Linting and type checking are executed automatically as part of a mandatory verification stack using predefined make targets. This process validates code quality and prevents regressions for changes affecting runtime code or build behavior.

Can I use this automated verification for changes that only affect build behavior?

Yes, automated verification is designed for any changes affecting runtime code, tests, or build behavior. It ensures that all such modifications pass formatting, linting, type checking, and unit tests before being merged.

Why does automated code verification stop immediately when a check fails?

Automated code verification stops immediately upon a check failure to highlight the exact issue and prevent further regressions. This fail-fast approach enforces a strict execution order, maintaining code health and quality.

What are the limitations of using make targets for code verification?

Make targets enforce a strict, fail-fast execution order for formatting, linting, type checking, and unit tests. Verification halts at the first failure, meaning subsequent checks will not run until the initial issue is resolved.