refactor: standardize file naming to use dashes instead of underscores (#1094)
Rename output/template files and update all references to use kebab-case (dashes) instead of snake_case (underscores) for consistency: - project_context.md -> project-context.md (13 references) - backlog_template.md -> backlog-template.md - agent_commands.md -> agent-commands.md - agent_persona.md -> agent-persona.md - agent_purpose_and_type.md -> agent-purpose-and-type.md
This commit is contained in:
parent
be7e07cc1a
commit
82e6433b69
|
|
@ -330,7 +330,7 @@ Review was saved to story file, but sprint-status.yaml may be out of sync.
|
||||||
<action>All action items are included in the standalone review report</action>
|
<action>All action items are included in the standalone review report</action>
|
||||||
<ask if="action items exist">Would you like me to create tracking items for these action items? (backlog/tasks)</ask>
|
<ask if="action items exist">Would you like me to create tracking items for these action items? (backlog/tasks)</ask>
|
||||||
<action if="user confirms">
|
<action if="user confirms">
|
||||||
If {{backlog_file}} does not exist, copy {installed_path}/backlog_template.md to {{backlog_file}} location.
|
If {{backlog_file}} does not exist, copy {installed_path}/backlog-template.md to {{backlog_file}} location.
|
||||||
Append a row per action item with Date={{date}}, Story="Ad-Hoc Review", Epic="N/A", Type, Severity, Owner (or "TBD"), Status="Open", Notes with file refs and context.
|
Append a row per action item with Date={{date}}, Story="Ad-Hoc Review", Epic="N/A", Type, Severity, Owner (or "TBD"), Status="Open", Notes with file refs and context.
|
||||||
</action>
|
</action>
|
||||||
</check>
|
</check>
|
||||||
|
|
@ -342,7 +342,7 @@ Review was saved to story file, but sprint-status.yaml may be out of sync.
|
||||||
Append under the story's "Tasks / Subtasks" a new subsection titled "Review Follow-ups (AI)", adding each item as an unchecked checkbox in imperative form, prefixed with "[AI-Review]" and severity. Example: "- [ ] [AI-Review][High] Add input validation on server route /api/x (AC #2)".
|
Append under the story's "Tasks / Subtasks" a new subsection titled "Review Follow-ups (AI)", adding each item as an unchecked checkbox in imperative form, prefixed with "[AI-Review]" and severity. Example: "- [ ] [AI-Review][High] Add input validation on server route /api/x (AC #2)".
|
||||||
</action>
|
</action>
|
||||||
<action>
|
<action>
|
||||||
If {{backlog_file}} does not exist, copy {installed_path}/backlog_template.md to {{backlog_file}} location.
|
If {{backlog_file}} does not exist, copy {installed_path}/backlog-template.md to {{backlog_file}} location.
|
||||||
Append a row per action item with Date={{date}}, Story={{epic_num}}.{{story_num}}, Epic={{epic_num}}, Type, Severity, Owner (or "TBD"), Status="Open", Notes with short context and file refs.
|
Append a row per action item with Date={{date}}, Story={{epic_num}}.{{story_num}}, Epic={{epic_num}}, Type, Severity, Owner (or "TBD"), Status="Open", Notes with short context and file refs.
|
||||||
</action>
|
</action>
|
||||||
<action>
|
<action>
|
||||||
|
|
|
||||||
|
|
@ -24,7 +24,7 @@ agent:
|
||||||
|
|
||||||
critical_actions:
|
critical_actions:
|
||||||
- "READ the entire story file BEFORE any implementation - tasks/subtasks sequence is your authoritative implementation guide"
|
- "READ the entire story file BEFORE any implementation - tasks/subtasks sequence is your authoritative implementation guide"
|
||||||
- "Load project_context.md if available for coding standards only - never let it override story requirements"
|
- "Load project-context.md if available for coding standards only - never let it override story requirements"
|
||||||
- "Execute tasks/subtasks IN ORDER as written in story file - no skipping, no reordering, no doing what you want"
|
- "Execute tasks/subtasks IN ORDER as written in story file - no skipping, no reordering, no doing what you want"
|
||||||
- "For each task/subtask: follow red-green-refactor cycle - write failing test first, then implementation"
|
- "For each task/subtask: follow red-green-refactor cycle - write failing test first, then implementation"
|
||||||
- "Mark task/subtask [x] ONLY when both implementation AND tests are complete and passing"
|
- "Mark task/subtask [x] ONLY when both implementation AND tests are complete and passing"
|
||||||
|
|
|
||||||
|
|
@ -94,7 +94,7 @@ Discover and load context documents using smart discovery:
|
||||||
|
|
||||||
**Project Context Rules (Critical for AI Agents):**
|
**Project Context Rules (Critical for AI Agents):**
|
||||||
|
|
||||||
1. Check for project context file: `**/project_context.md`
|
1. Check for project context file: `**/project-context.md`
|
||||||
2. If exists: Load COMPLETE file contents - this contains critical rules for AI agents
|
2. If exists: Load COMPLETE file contents - this contains critical rules for AI agents
|
||||||
3. Add to frontmatter `hasProjectContext: true` and track file path
|
3. Add to frontmatter `hasProjectContext: true` and track file path
|
||||||
4. Report to user: "Found existing project context with {number_of_rules} agent rules"
|
4. Report to user: "Found existing project context with {number_of_rules} agent rules"
|
||||||
|
|
|
||||||
|
|
@ -280,7 +280,7 @@ Your architecture will ensure consistent, high-quality implementation across all
|
||||||
|
|
||||||
**💡 Optional Enhancement: Project Context File**
|
**💡 Optional Enhancement: Project Context File**
|
||||||
|
|
||||||
Would you like to create a `project_context.md` file? This is a concise, optimized guide for AI agents that captures:
|
Would you like to create a `project-context.md` file? This is a concise, optimized guide for AI agents that captures:
|
||||||
|
|
||||||
- Critical language and framework rules they might miss
|
- Critical language and framework rules they might miss
|
||||||
- Specific patterns and conventions for your project
|
- Specific patterns and conventions for your project
|
||||||
|
|
@ -310,7 +310,7 @@ This will help ensure consistent implementation by capturing:
|
||||||
- Testing and quality standards
|
- Testing and quality standards
|
||||||
- Anti-patterns to avoid
|
- Anti-patterns to avoid
|
||||||
|
|
||||||
The workflow will collaborate with you to create an optimized `project_context.md` file that AI agents will read before implementing any code."
|
The workflow will collaborate with you to create an optimized `project-context.md` file that AI agents will read before implementing any code."
|
||||||
|
|
||||||
**Execute the Generate Project Context workflow:**
|
**Execute the Generate Project Context workflow:**
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -35,7 +35,7 @@ validation-rules:
|
||||||
- [ ] **Acceptance Criteria Satisfaction:** Implementation satisfies EVERY Acceptance Criterion in the story
|
- [ ] **Acceptance Criteria Satisfaction:** Implementation satisfies EVERY Acceptance Criterion in the story
|
||||||
- [ ] **No Ambiguous Implementation:** Clear, unambiguous implementation that meets story requirements
|
- [ ] **No Ambiguous Implementation:** Clear, unambiguous implementation that meets story requirements
|
||||||
- [ ] **Edge Cases Handled:** Error conditions and edge cases appropriately addressed
|
- [ ] **Edge Cases Handled:** Error conditions and edge cases appropriately addressed
|
||||||
- [ ] **Dependencies Within Scope:** Only uses dependencies specified in story or project_context.md
|
- [ ] **Dependencies Within Scope:** Only uses dependencies specified in story or project-context.md
|
||||||
|
|
||||||
## 🧪 Testing & Quality Assurance
|
## 🧪 Testing & Quality Assurance
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@ Discover the project's technology stack, existing patterns, and critical impleme
|
||||||
|
|
||||||
First, check if project context already exists:
|
First, check if project context already exists:
|
||||||
|
|
||||||
- Look for file at `{output_folder}/project_context.md`
|
- Look for file at `{output_folder}/project-context.md`
|
||||||
- If exists: Read complete file to understand existing rules
|
- If exists: Read complete file to understand existing rules
|
||||||
- Present to user: "Found existing project context with {number_of_sections} sections. Would you like to update this or create a new one?"
|
- Present to user: "Found existing project context with {number_of_sections} sections. Would you like to update this or create a new one?"
|
||||||
|
|
||||||
|
|
@ -122,7 +122,7 @@ Based on discovery, create or update the context document:
|
||||||
|
|
||||||
#### A. Fresh Document Setup (if no existing context)
|
#### A. Fresh Document Setup (if no existing context)
|
||||||
|
|
||||||
Copy template from `{installed_path}/project-context-template.md` to `{output_folder}/project_context.md`
|
Copy template from `{installed_path}/project-context-template.md` to `{output_folder}/project-context.md`
|
||||||
Initialize frontmatter with:
|
Initialize frontmatter with:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
|
||||||
|
|
@ -288,7 +288,7 @@ After each category, show the generated rules and present choices:
|
||||||
|
|
||||||
## APPEND TO PROJECT CONTEXT:
|
## APPEND TO PROJECT CONTEXT:
|
||||||
|
|
||||||
When user selects 'C' for a category, append the content directly to `{output_folder}/project_context.md` using the structure from step 8.
|
When user selects 'C' for a category, append the content directly to `{output_folder}/project-context.md` using the structure from step 8.
|
||||||
|
|
||||||
## SUCCESS METRICS:
|
## SUCCESS METRICS:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -134,7 +134,7 @@ Based on user skill level, present the completion:
|
||||||
**Expert Mode:**
|
**Expert Mode:**
|
||||||
"Project context complete. Optimized for LLM consumption with {{rule_count}} critical rules across {{section_count}} sections.
|
"Project context complete. Optimized for LLM consumption with {{rule_count}} critical rules across {{section_count}} sections.
|
||||||
|
|
||||||
File saved to: `{output_folder}/project_context.md`
|
File saved to: `{output_folder}/project-context.md`
|
||||||
|
|
||||||
Ready for AI agent integration."
|
Ready for AI agent integration."
|
||||||
|
|
||||||
|
|
@ -227,7 +227,7 @@ Present final completion to user:
|
||||||
"✅ **Project Context Generation Complete!**
|
"✅ **Project Context Generation Complete!**
|
||||||
|
|
||||||
Your optimized project context file is ready at:
|
Your optimized project context file is ready at:
|
||||||
`{output_folder}/project_context.md`
|
`{output_folder}/project-context.md`
|
||||||
|
|
||||||
**📊 Context Summary:**
|
**📊 Context Summary:**
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,11 +1,11 @@
|
||||||
---
|
---
|
||||||
name: generate-project-context
|
name: generate-project-context
|
||||||
description: Creates a concise project_context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency.
|
description: Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Generate Project Context Workflow
|
# Generate Project Context Workflow
|
||||||
|
|
||||||
**Goal:** Create a concise, optimized `project_context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of.
|
**Goal:** Create a concise, optimized `project-context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of.
|
||||||
|
|
||||||
**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project.
|
**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project.
|
||||||
|
|
||||||
|
|
@ -37,7 +37,7 @@ Load config from `{project-root}/.bmad/bmm/config.yaml` and resolve:
|
||||||
|
|
||||||
- `installed_path` = `{project-root}/.bmad/bmm/workflows/generate-project-context`
|
- `installed_path` = `{project-root}/.bmad/bmm/workflows/generate-project-context`
|
||||||
- `template_path` = `{installed_path}/project-context-template.md`
|
- `template_path` = `{installed_path}/project-context-template.md`
|
||||||
- `output_file` = `{output_folder}/project_context.md`
|
- `output_file` = `{output_folder}/project-context.md`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue