refactor(augment): remove legacy YAML/XML workflow rules from code review guidelines
All workflows have been converted to markdown. Remove workflow.yaml, workflow.xml, and config_source references from Augment review rules. Drop the entire xml_workflows section (5 rules) and the YAML-specific standard_workflow_instructions rule.
This commit is contained in:
parent
4c470d9948
commit
0fc0fcdd46
|
|
@ -56,17 +56,13 @@ areas:
|
||||||
- "src/**/workflows/**"
|
- "src/**/workflows/**"
|
||||||
rules:
|
rules:
|
||||||
- id: "workflow_entry_point_required"
|
- id: "workflow_entry_point_required"
|
||||||
description: "Every workflow folder must have workflow.yaml, workflow.md, or workflow.xml as entry point"
|
description: "Every workflow folder must have workflow.md as entry point"
|
||||||
severity: "high"
|
severity: "high"
|
||||||
|
|
||||||
- id: "sharded_workflow_steps_folder"
|
- id: "sharded_workflow_steps_folder"
|
||||||
description: "Sharded workflows (using workflow.md) must have steps/ folder with numbered files (step-01-*.md, step-02-*.md)"
|
description: "Sharded workflows (using workflow.md) must have steps/ folder with numbered files (step-01-*.md, step-02-*.md)"
|
||||||
severity: "high"
|
severity: "high"
|
||||||
|
|
||||||
- id: "standard_workflow_instructions"
|
|
||||||
description: "Standard workflows using workflow.yaml must include instructions.md for execution guidance"
|
|
||||||
severity: "medium"
|
|
||||||
|
|
||||||
- id: "workflow_step_limit"
|
- id: "workflow_step_limit"
|
||||||
description: "Workflows should have 5-10 steps maximum to prevent context loss in LLM execution"
|
description: "Workflows should have 5-10 steps maximum to prevent context loss in LLM execution"
|
||||||
severity: "medium"
|
severity: "medium"
|
||||||
|
|
@ -75,11 +71,9 @@ areas:
|
||||||
# WORKFLOW ENTRY FILE RULES
|
# WORKFLOW ENTRY FILE RULES
|
||||||
# ============================================
|
# ============================================
|
||||||
workflow_definitions:
|
workflow_definitions:
|
||||||
description: "Workflow entry files (workflow.yaml, workflow.md, workflow.xml)"
|
description: "Workflow entry files (workflow.md)"
|
||||||
globs:
|
globs:
|
||||||
- "src/**/workflows/**/workflow.yaml"
|
|
||||||
- "src/**/workflows/**/workflow.md"
|
- "src/**/workflows/**/workflow.md"
|
||||||
- "src/**/workflows/**/workflow.xml"
|
|
||||||
rules:
|
rules:
|
||||||
- id: "workflow_name_required"
|
- id: "workflow_name_required"
|
||||||
description: "Workflow entry files must define 'name' field in frontmatter or root element"
|
description: "Workflow entry files must define 'name' field in frontmatter or root element"
|
||||||
|
|
@ -89,10 +83,6 @@ areas:
|
||||||
description: "Workflow entry files must include 'description' explaining the workflow's purpose"
|
description: "Workflow entry files must include 'description' explaining the workflow's purpose"
|
||||||
severity: "high"
|
severity: "high"
|
||||||
|
|
||||||
- id: "workflow_config_source"
|
|
||||||
description: "Workflows should reference config_source for variable resolution (e.g., {project-root}/_bmad/module/config.yaml)"
|
|
||||||
severity: "medium"
|
|
||||||
|
|
||||||
- id: "workflow_installed_path"
|
- id: "workflow_installed_path"
|
||||||
description: "Workflows should define installed_path for relative file references within the workflow"
|
description: "Workflows should define installed_path for relative file references within the workflow"
|
||||||
severity: "medium"
|
severity: "medium"
|
||||||
|
|
@ -149,35 +139,6 @@ areas:
|
||||||
description: "Steps presenting user menus ([C] Continue, [a] Advanced, etc.) must HALT and wait for response"
|
description: "Steps presenting user menus ([C] Continue, [a] Advanced, etc.) must HALT and wait for response"
|
||||||
severity: "high"
|
severity: "high"
|
||||||
|
|
||||||
# ============================================
|
|
||||||
# XML WORKFLOW/TASK RULES
|
|
||||||
# ============================================
|
|
||||||
xml_workflows:
|
|
||||||
description: "XML-based workflows and tasks"
|
|
||||||
globs:
|
|
||||||
- "src/**/workflows/**/*.xml"
|
|
||||||
- "src/**/tasks/**/*.xml"
|
|
||||||
rules:
|
|
||||||
- id: "xml_task_id_required"
|
|
||||||
description: "XML tasks must have unique 'id' attribute on root task element"
|
|
||||||
severity: "high"
|
|
||||||
|
|
||||||
- id: "xml_llm_instructions"
|
|
||||||
description: "XML workflows should include <llm> section with critical execution instructions for the agent"
|
|
||||||
severity: "medium"
|
|
||||||
|
|
||||||
- id: "xml_step_numbering"
|
|
||||||
description: "XML steps should use n='X' attribute for sequential numbering"
|
|
||||||
severity: "medium"
|
|
||||||
|
|
||||||
- id: "xml_action_tags"
|
|
||||||
description: "Use <action> for required actions, <ask> for user input (must HALT), <goto> for jumps, <check if='...'> for conditionals"
|
|
||||||
severity: "medium"
|
|
||||||
|
|
||||||
- id: "xml_ask_must_halt"
|
|
||||||
description: "<ask> tags require agent to HALT and wait for user response before continuing"
|
|
||||||
severity: "high"
|
|
||||||
|
|
||||||
# ============================================
|
# ============================================
|
||||||
# WORKFLOW CONTENT QUALITY
|
# WORKFLOW CONTENT QUALITY
|
||||||
# ============================================
|
# ============================================
|
||||||
|
|
@ -185,7 +146,6 @@ areas:
|
||||||
description: "Content quality and consistency rules for all workflow files"
|
description: "Content quality and consistency rules for all workflow files"
|
||||||
globs:
|
globs:
|
||||||
- "src/**/workflows/**/*.md"
|
- "src/**/workflows/**/*.md"
|
||||||
- "src/**/workflows/**/*.yaml"
|
|
||||||
rules:
|
rules:
|
||||||
- id: "communication_language_variable"
|
- id: "communication_language_variable"
|
||||||
description: "Workflows should use {communication_language} variable for agent output language consistency"
|
description: "Workflows should use {communication_language} variable for agent output language consistency"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue