Skip to content

Commit 647a2b4

Browse files
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 <[email protected]>
1 parent c16f478 commit 647a2b4

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

chatmodes/implementation-plan.chatmode.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,25 @@ All implementation plans must strictly adhere to the following template. Each se
6363
- Tables must include all required columns with specific task details
6464
- No placeholder text may remain in the final output
6565

66+
## Status
67+
68+
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.
69+
6670
```md
6771
---
6872
goal: [Concise Title Describing the Package Plan's Goal]
6973
version: [Optional: e.g., 1.0, Date]
7074
date_created: [YYYY-MM-DD]
7175
last_updated: [Optional: YYYY-MM-DD]
7276
owner: [Optional: Team/Individual responsible for this spec]
77+
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
7378
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
7479
---
7580

7681
# Introduction
7782

83+
![Status: <status>](https://img.shields.io/badge/status-<status>-<status_color>)
84+
7885
[A short concise introduction to the plan and the goal it is intended to achieve.]
7986

8087
## 1. Requirements & Constraints

prompts/create-implementation-plan.prompt.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ tools: ['changes', 'codebase', 'editFiles', 'extensions', 'fetch', 'githubRepo',
66
# Create Implementation Plan
77

88
## Primary Directive
9+
910
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.
1011

1112
## Execution Context
13+
1214
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.
1315

1416
## Core Requirements
@@ -19,6 +21,7 @@ This prompt is designed for AI-to-AI communication and automated processing. All
1921
- Ensure complete self-containment with no external dependencies for understanding
2022

2123
## Plan Structure Requirements
24+
2225
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.
2326

2427
## Phase Architecture
@@ -47,6 +50,7 @@ Plans must consist of discrete, atomic phases containing executable tasks. Each
4750
- File must be valid Markdown with proper front matter structure
4851

4952
## Mandatory Template Structure
53+
5054
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.
5155

5256
## Template Validation Rules
@@ -57,18 +61,25 @@ All implementation plans must strictly adhere to the following template. Each se
5761
- Tables must include all required columns
5862
- No placeholder text may remain in the final output
5963

64+
## Status
65+
66+
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.
67+
6068
```md
6169
---
6270
goal: [Concise Title Describing the Package Implementation Plan's Goal]
6371
version: [Optional: e.g., 1.0, Date]
6472
date_created: [YYYY-MM-DD]
6573
last_updated: [Optional: YYYY-MM-DD]
6674
owner: [Optional: Team/Individual responsible for this spec]
75+
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
6776
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
6877
---
6978

7079
# Introduction
7180

81+
![Status: <status>](https://img.shields.io/badge/status-<status>-<status_color>)
82+
7283
[A short concise introduction to the plan and the goal it is intended to achieve.]
7384

7485
## 1. Requirements & Constraints

prompts/update-implementation-plan.prompt.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,25 @@ All implementation plans must strictly adhere to the following template. Each se
6161
- Tables must include all required columns
6262
- No placeholder text may remain in the final output
6363

64+
## Status
65+
66+
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.
67+
6468
```md
6569
---
6670
goal: [Concise Title Describing the Package Implementation Plan's Goal]
6771
version: [Optional: e.g., 1.0, Date]
6872
date_created: [YYYY-MM-DD]
6973
last_updated: [Optional: YYYY-MM-DD]
7074
owner: [Optional: Team/Individual responsible for this spec]
75+
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
7176
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
7277
---
7378

7479
# Introduction
7580

81+
![Status: <status>](https://img.shields.io/badge/status-<status>-<status_color>)
82+
7683
[A short concise introduction to the plan and the goal it is intended to achieve.]
7784

7885
## 1. Requirements & Constraints

0 commit comments

Comments
 (0)