bugfix-workflow

Automates structured bug-fix workflows with Current, Expected and Unchanged Behavior definitions.

5.0k|548|Updated May 14, 2025

Search Tags:#workflow #design #testing #documentation #regression #root-cause #bugfix

Ready to run

npx skills add https://github.com/dtyq/magic --skill bugfix-workflow-dtyq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bugfix-workflow
Source: https://github.com/dtyq/magic/tree/main/frontend/magic-web/.cursor/skills/bugfix-workflow
Command: npx skills add https://github.com/dtyq/magic --skill bugfix-workflow-dtyq

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

结构化的缺陷修复流程，帮助团队在修复复杂缺陷时记录 Current Behavior、Expected Behavior、和 Unchanged Behavior，并执行根因分析、修复设计、回归测试以及实现任务，以沉淀修复文档。

Core Features & Use Cases

定义缺陷修复的三段式行为：Current Behavior、Expected Behavior、Unchanged Behavior，确保回归可控。
通过分步设计与任务分解，提升修复的透明度和可追溯性。
适用于需要沉淀修复过程、降低回归风险的复杂缺陷场景。

Quick Start

直接创建并填充 bugfix.md、design.md、tasks.md，确保每份文档包含核心行为定义与回归预防。

Frequently Asked Questions about bugfix-workflow

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

FAQPage Schema

What is a structured bugfix workflow and when do I need one?▼

A structured bugfix workflow records Current Behavior, Expected Behavior, and Unchanged Behavior before advancing to root-cause analysis and regression testing. It is needed for complex defects carrying high regression risk or when formal fix documentation is required.

How do I document a complex defect to prevent regression?▼

To prevent regression, define the defect using a three-part behavior model covering current, expected, and unchanged states. Then capture root-cause analysis, fix design, and regression testing details within structured markdown artifacts like bugfix.md, design.md, and tasks.md.

How do I create traceable documentation for a software bugfix?▼

Create traceable bugfix documentation by filling structured templates including bugfix.md, design.md, and tasks.md. These artifacts ensure repeatable QA by linking current behavior definitions directly to root-cause analysis, fix design, and implementation tasks.

What is the best way to manage root-cause analysis for high-risk defects?▼

Managing root-cause analysis for high-risk defects requires enforcing a step-by-step workflow that separates behavior definition from fix design. This ensures transparency and traceability by decomposing tasks and mandating evidence artifacts before implementation proceeds.

Do I need markdown templates to start a formal bugfix process?▼

Yes, markdown templates like bugfix.md, design.md, and tasks.md are required to start. They capture core behavior definitions, fix designs, and regression prevention details, ensuring the formal bugfix process remains repeatable and traceable.

When should I avoid using a formal bugfix workflow?▼

Avoid using a formal bugfix workflow for simple, low-risk defects requiring minimal formal documentation or carrying negligible regression risk. The structured process is designed specifically for complex defects where traceability and repeatable QA are necessary.