UPDATE: Add status badge to implementation plan templates (#108)
* CHANGE: Add status section to implementation plan templates - Introduced a status section in the implementation plan templates to define the current state of the plan. - Status options include: Completed, In progress, Planned, Deprecated, and On Hold. - Status will be displayed as a badge in the introduction section. * CHANGE: Update status formatting in implementation plans - Enclosed status options in quotes for consistency - Updated formatting in implementation plan and prompt files --------- Co-authored-by: Matt Soucoup <masoucou@microsoft.com>
This commit is contained in:
Daniel Scott-Raynsford
GitHub
parent
c16f4786f0
commit
647a2b43c3
@ -63,6 +63,10 @@ All implementation plans must strictly adhere to the following template. Each se
|
||||
- Tables must include all required columns with specific task details
|
||||
- No placeholder text may remain in the final output
|
||||
|
||||
## Status
|
||||
|
||||
The status of the implementation plan must be clearly defined in the front matter and must reflect the current state of the plan. The status can be one of the following (status_color in brackets): `Completed` (bright green badge), `In progress` (yellow badge), `Planned` (blue badge), `Deprecated` (red badge), or `On Hold` (orange badge). It should also be displayed as a badge in the introduction section.
|
||||
|
||||
```md
|
||||
---
|
||||
goal: [Concise Title Describing the Package Plan's Goal]
|
||||
@ -70,11 +74,14 @@ version: [Optional: e.g., 1.0, Date]
|
||||
date_created: [YYYY-MM-DD]
|
||||
last_updated: [Optional: YYYY-MM-DD]
|
||||
owner: [Optional: Team/Individual responsible for this spec]
|
||||
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
|
||||
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
|
||||
|
||||
[A short concise introduction to the plan and the goal it is intended to achieve.]
|
||||
|
||||
## 1. Requirements & Constraints
|
||||
|
||||
@ -6,9 +6,11 @@ tools: ['changes', 'codebase', 'editFiles', 'extensions', 'fetch', 'githubRepo',
|
||||
# Create Implementation Plan
|
||||
|
||||
## Primary Directive
|
||||
|
||||
Your goal is to create a new implementation plan file for `${input:PlanPurpose}`. Your output must be machine-readable, deterministic, and structured for autonomous execution by other AI systems or humans.
|
||||
|
||||
## Execution Context
|
||||
|
||||
This prompt is designed for AI-to-AI communication and automated processing. All instructions must be interpreted literally and executed systematically without human interpretation or clarification.
|
||||
|
||||
## Core Requirements
|
||||
@ -19,6 +21,7 @@ This prompt is designed for AI-to-AI communication and automated processing. All
|
||||
- Ensure complete self-containment with no external dependencies for understanding
|
||||
|
||||
## Plan Structure Requirements
|
||||
|
||||
Plans must consist of discrete, atomic phases containing executable tasks. Each phase must be independently processable by AI agents or humans without cross-phase dependencies unless explicitly declared.
|
||||
|
||||
## Phase Architecture
|
||||
@ -47,6 +50,7 @@ Plans must consist of discrete, atomic phases containing executable tasks. Each
|
||||
- File must be valid Markdown with proper front matter structure
|
||||
|
||||
## Mandatory Template Structure
|
||||
|
||||
All implementation plans must strictly adhere to the following template. Each section is required and must be populated with specific, actionable content. AI agents must validate template compliance before execution.
|
||||
|
||||
## Template Validation Rules
|
||||
@ -57,6 +61,10 @@ All implementation plans must strictly adhere to the following template. Each se
|
||||
- Tables must include all required columns
|
||||
- No placeholder text may remain in the final output
|
||||
|
||||
## Status
|
||||
|
||||
The status of the implementation plan must be clearly defined in the front matter and must reflect the current state of the plan. The status can be one of the following (status_color in brackets): `Completed` (bright green badge), `In progress` (yellow badge), `Planned` (blue badge), `Deprecated` (red badge), or `On Hold` (orange badge). It should also be displayed as a badge in the introduction section.
|
||||
|
||||
```md
|
||||
---
|
||||
goal: [Concise Title Describing the Package Implementation Plan's Goal]
|
||||
@ -64,11 +72,14 @@ version: [Optional: e.g., 1.0, Date]
|
||||
date_created: [YYYY-MM-DD]
|
||||
last_updated: [Optional: YYYY-MM-DD]
|
||||
owner: [Optional: Team/Individual responsible for this spec]
|
||||
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
|
||||
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
|
||||
|
||||
[A short concise introduction to the plan and the goal it is intended to achieve.]
|
||||
|
||||
## 1. Requirements & Constraints
|
||||
|
||||
@ -61,6 +61,10 @@ All implementation plans must strictly adhere to the following template. Each se
|
||||
- Tables must include all required columns
|
||||
- No placeholder text may remain in the final output
|
||||
|
||||
## Status
|
||||
|
||||
The status of the implementation plan must be clearly defined in the front matter and must reflect the current state of the plan. The status can be one of the following (status_color in brackets): `Completed` (bright green badge), `In progress` (yellow badge), `Planned` (blue badge), `Deprecated` (red badge), or `On Hold` (orange badge). It should also be displayed as a badge in the introduction section.
|
||||
|
||||
```md
|
||||
---
|
||||
goal: [Concise Title Describing the Package Implementation Plan's Goal]
|
||||
@ -68,11 +72,14 @@ version: [Optional: e.g., 1.0, Date]
|
||||
date_created: [YYYY-MM-DD]
|
||||
last_updated: [Optional: YYYY-MM-DD]
|
||||
owner: [Optional: Team/Individual responsible for this spec]
|
||||
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
|
||||
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
|
||||
|
||||
[A short concise introduction to the plan and the goal it is intended to achieve.]
|
||||
|
||||
## 1. Requirements & Constraints
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user