@vfarcic/dot-ai 0.117.0 β 0.119.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +91 -140
- package/package.json +1 -1
- package/shared-prompts/prd-create.md +15 -1
- package/shared-prompts/prd-done.md +186 -4
- package/shared-prompts/prd-next.md +0 -2
- package/shared-prompts/prd-start.md +2 -2
package/README.md
CHANGED
|
@@ -4,146 +4,81 @@
|
|
|
4
4
|
|
|
5
5
|

|
|
6
6
|
|
|
7
|
+
[](https://www.npmjs.com/package/@vfarcic/dot-ai)
|
|
8
|
+
[](https://www.npmjs.com/package/@vfarcic/dot-ai)
|
|
9
|
+
[](https://github.com/vfarcic/dot-ai/releases/latest)
|
|
10
|
+
[](LICENSE)
|
|
11
|
+

|
|
12
|
+
[](https://scorecard.dev/viewer/?uri=github.com/vfarcic/dot-ai)
|
|
13
|
+
[](https://github.com/vfarcic/dot-ai)
|
|
14
|
+
|
|
7
15
|
</div>
|
|
8
16
|
|
|
9
|
-
|
|
17
|
+
**AI-powered platform engineering and DevOps automation through intelligent Kubernetes operations and conversational workflows.**
|
|
10
18
|
|
|
11
19
|
π [Quick Start](./docs/quick-start.md) | π§ [MCP Setup](./docs/mcp-setup.md) | π οΈ [Features & Tools](./docs/mcp-tools-overview.md)
|
|
12
20
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
### Kubernetes Deployment
|
|
16
|
-
- **Developers**: Deploy applications without needing deep Kubernetes expertise
|
|
17
|
-
- **Platform Engineers**: Create organizational deployment patterns that enhance AI recommendations with institutional knowledge and best practices, and scan cluster resources to enable semantic matching for dramatically improved recommendation accuracy
|
|
18
|
-
- **Security Engineers**: Define governance policies that integrate into deployment workflows with optional Kyverno enforcement
|
|
19
|
-
|
|
20
|
-
### Kubernetes Issue Remediation
|
|
21
|
-
- **DevOps Engineers**: Quickly diagnose and fix Kubernetes issues without deep troubleshooting expertise
|
|
22
|
-
- **SRE Teams**: Automate root cause analysis and generate executable remediation commands
|
|
23
|
-
- **Support Teams**: Handle incident response with AI-guided investigation and repair workflows
|
|
24
|
-
|
|
25
|
-
<!--
|
|
26
|
-
### Platform Building
|
|
27
|
-
DEVELOPER NOTE: This tool is under active development with incomplete functionality. Not recommended for production use.
|
|
28
|
-
- **Platform Engineers**: Install and configure platform tools conversationally without memorizing script paths and commands
|
|
29
|
-
- **New Team Members**: Build platform infrastructure through zero-knowledge guided workflows
|
|
30
|
-
- **DevOps Teams**: Create and manage Kubernetes clusters through natural language interactions
|
|
31
|
-
-->
|
|
32
|
-
|
|
33
|
-
### Shared Prompts Library
|
|
34
|
-
- **Development Teams**: Share proven prompts across projects without file management
|
|
35
|
-
- **Project Managers**: Standardize workflows with consistent prompt usage across teams
|
|
36
|
-
- **Individual Developers**: Access curated prompt library via native slash commands
|
|
37
|
-
|
|
38
|
-
### Project Setup & Governance
|
|
39
|
-
- **Project Maintainers**: Bootstrap new repositories with governance, legal, and security files
|
|
40
|
-
- **Development Teams**: Standardize repository setup and workflows across projects
|
|
41
|
-
- **Security Teams**: Implement consistent security policies, vulnerability reporting, and compliance standards
|
|
42
|
-
|
|
43
|
-
### AI Integration
|
|
44
|
-
- **AI Agents**: Integrate all capabilities with Claude Code, Cursor, or VS Code for conversational workflows
|
|
45
|
-
- **Multiple AI Providers**: Choose from multiple AI models and providers to optimize for quality, cost, and reliability - see [AI Model Configuration](./docs/mcp-setup.md#ai-model-configuration)
|
|
46
|
-
- **REST API**: Access all tools via standard HTTP endpoints for CI/CD pipelines, automation scripts, and traditional applications
|
|
21
|
+
---
|
|
47
22
|
|
|
48
|
-
##
|
|
23
|
+
## What is DevOps AI Toolkit?
|
|
49
24
|
|
|
50
|
-
|
|
51
|
-
π **Smart Discovery**: Automatically finds all available resources and operators in your cluster
|
|
52
|
-
π§ **Semantic Capability Management**: Discovers what each resource actually does for intelligent matching
|
|
53
|
-
π€ **AI Recommendations**: Smart intent clarification gathers missing context, then provides deployment suggestions tailored to your specific cluster setup with enhanced semantic understanding
|
|
54
|
-
π§ **Operator-Aware**: Leverages custom operators and CRDs when available
|
|
55
|
-
π **Complete Workflow**: From discovery to deployment with automated Kubernetes integration
|
|
25
|
+
DevOps AI Toolkit brings AI-powered intelligence to platform engineering, Kubernetes operations, and development workflows. It provides intelligent Kubernetes deployment recommendations through capability discovery and semantic matching, AI-powered issue remediation, automated repository setup with governance and security files, and shared prompt libraries for consistent development workflowsβall through natural language conversation.
|
|
56
26
|
|
|
57
|
-
|
|
27
|
+
Built on the Model Context Protocol (MCP), it integrates seamlessly with Claude Code, Cursor, and VS Code to provide conversational interaction for complex DevOps and development tasks.
|
|
58
28
|
|
|
59
|
-
|
|
60
|
-
Transform how AI understands your cluster by discovering semantic capabilities of each resource:
|
|
29
|
+
## Mission
|
|
61
30
|
|
|
62
|
-
|
|
31
|
+
DevOps AI Toolkit democratizes platform engineering and cloud native operations by making complex workflows accessible through AI-powered automation. We eliminate the expertise barrier that prevents teams from adopting best practices in Kubernetes operations, repository governance, and standardized development workflowsβmaking professional-grade DevOps accessible through natural language interaction.
|
|
63
32
|
|
|
64
|
-
|
|
33
|
+
## Who Should Use This?
|
|
65
34
|
|
|
66
|
-
**
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
35
|
+
**DevOps AI Toolkit is for teams who want to**:
|
|
36
|
+
- Manage cloud resources (AWS, Azure, GCP) using Kubernetes as a control plane (developers, platform engineers)
|
|
37
|
+
- Quickly diagnose and fix cluster and infrastructure issues (SREs, DevOps engineers)
|
|
38
|
+
- Standardize resource provisioning with organizational patterns and policies (security engineers, platform teams)
|
|
39
|
+
- Bootstrap repositories with governance and security files (project maintainers)
|
|
40
|
+
- Access curated development prompts through native slash commands (development teams)
|
|
72
41
|
|
|
73
|
-
|
|
74
|
-
```
|
|
75
|
-
User: "I need a PostgreSQL database"
|
|
76
|
-
AI: Gets pre-filtered relevant resources with rich context
|
|
77
|
-
Result: Finds sqls.devopstoolkit.live as perfect match β¨
|
|
78
|
-
```
|
|
42
|
+
## Scope
|
|
79
43
|
|
|
80
|
-
|
|
44
|
+
### In Scope
|
|
45
|
+
- AI-powered resource provisioning recommendations using Kubernetes as control plane
|
|
46
|
+
- Intelligent issue remediation and root cause analysis
|
|
47
|
+
- Organizational pattern and policy management with semantic search
|
|
48
|
+
- MCP-based integration with AI coding assistants
|
|
49
|
+
- Multi-provider AI model support (Claude, GPT, Gemini)
|
|
50
|
+
- Project setup with governance, legal, and security files
|
|
81
51
|
|
|
82
|
-
###
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
π **Safety Mechanisms**: Automatic fallback to manual mode when validation discovers additional issues
|
|
87
|
-
π― **Cross-Resource Intelligence**: Understands how pod issues may require fixes in different resource types (storage, networking, etc.)
|
|
52
|
+
### Out of Scope
|
|
53
|
+
- Kubernetes cluster provisioning/management (delegates to existing tools)
|
|
54
|
+
- CI/CD pipeline execution (provides recommendations only)
|
|
55
|
+
- Application runtime monitoring (integrates with existing observability tools)
|
|
88
56
|
|
|
89
|
-
|
|
57
|
+
## Key Features
|
|
90
58
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
π£οΈ **Natural Language Operations**: Install tools and create clusters through conversation without memorizing commands
|
|
95
|
-
π **Dynamic Discovery**: Automatically discovers 21+ available platform operations from infrastructure scripts
|
|
96
|
-
π€ **AI-Powered Intent Mapping**: Understands variations like "Install Argo CD", "Set up ArgoCD", "Deploy Argo CD"
|
|
97
|
-
π¬ **Conversational Configuration**: Guides through parameter collection step-by-step with sensible defaults
|
|
98
|
-
π― **Zero-Knowledge Onboarding**: New users successfully build platforms without documentation
|
|
99
|
-
|
|
100
|
-
π [Learn more β](./docs/mcp-build-platform-guide.md)
|
|
101
|
-
-->
|
|
102
|
-
|
|
103
|
-
### Organizational Pattern Management
|
|
104
|
-
ποΈ **Pattern Creation**: Define organizational deployment patterns that capture institutional knowledge
|
|
105
|
-
π§ **AI Enhancement**: Patterns automatically enhance deployment recommendations with organizational context
|
|
106
|
-
π **Semantic Search**: Uses Vector DB (Qdrant) for intelligent pattern matching based on user intent
|
|
107
|
-
π **Best Practices**: Share deployment standards across teams through reusable patterns
|
|
108
|
-
|
|
109
|
-
π [Learn more β](./docs/pattern-management-guide.md)
|
|
110
|
-
|
|
111
|
-
### Policy Management & Governance
|
|
112
|
-
π‘οΈ **Policy Creation**: Define governance policies that guide users toward compliant configurations
|
|
113
|
-
β οΈ **Compliance Integration**: Policies create required questions with compliance indicators during deployment
|
|
114
|
-
π€ **Kyverno Generation**: Automatically generates Kyverno ClusterPolicies for active enforcement
|
|
115
|
-
π― **Proactive Governance**: Prevents configuration drift by embedding compliance into the recommendation workflow
|
|
116
|
-
π **Vector Storage**: Uses Qdrant Vector DB for semantic policy matching and retrieval
|
|
117
|
-
|
|
118
|
-
π [Learn more β](./docs/policy-management-guide.md)
|
|
119
|
-
|
|
120
|
-
### Shared Prompts Library
|
|
121
|
-
π― **Native Slash Commands**: Prompts appear as `/dot-ai:prompt-name` in your coding agent
|
|
122
|
-
π **Curated Library**: Access proven prompts for code review, documentation, architecture, and project management
|
|
123
|
-
π **Zero Setup**: Connect to MCP server and prompts are immediately available across all projects
|
|
124
|
-
π€ **Team Consistency**: Standardized prompt usage with centralized management
|
|
59
|
+
### π Resource Provisioning Intelligence
|
|
60
|
+
Automatically discovers cluster resources using semantic capability management. AI understands what each resource actually does, providing intelligent recommendations for provisioning resources across clouds using Kubernetes as a control plane.
|
|
61
|
+
π [Deployment Guide](./docs/mcp-recommendation-guide.md) | [Capability Management](./docs/mcp-capability-management-guide.md)
|
|
125
62
|
|
|
126
|
-
|
|
63
|
+
### π οΈ Issue Remediation
|
|
64
|
+
AI-powered root cause analysis with multi-step investigation, executable remediation commands, and safety mechanisms for manual or automatic execution.
|
|
65
|
+
π [Learn more β](./docs/mcp-remediate-guide.md)
|
|
127
66
|
|
|
128
|
-
###
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
π§ **GitHub Automation**: Sets up Renovate for dependency updates, PR labeling, and stale issue management
|
|
132
|
-
π‘οΈ **Security Workflows**: Includes OpenSSF Scorecard for security posture analysis
|
|
133
|
-
β
**Standards-Based**: All templates based on authoritative sources (Contributor Covenant, OpenSSF, GitHub)
|
|
67
|
+
### ποΈ Pattern & Policy Management
|
|
68
|
+
Capture organizational knowledge and governance policies that automatically enhance AI recommendations with best practices and compliance requirements. Uses vector search for intelligent semantic matching.
|
|
69
|
+
π [Pattern Management](./docs/pattern-management-guide.md) | [Policy Management](./docs/policy-management-guide.md)
|
|
134
70
|
|
|
71
|
+
### π¦ Project Setup & Governance
|
|
72
|
+
Generate 25+ governance, legal, and automation files (LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, GitHub workflows, Renovate, OpenSSF Scorecard) for repository standardization.
|
|
135
73
|
π [Learn more β](./docs/mcp-project-setup-guide.md)
|
|
136
74
|
|
|
137
|
-
###
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
π― **Multiple AI Providers**: Choose from multiple AI models and providers to optimize for quality, cost, and reliability - see [AI Model Configuration](./docs/mcp-setup.md#ai-model-configuration)
|
|
75
|
+
### π¬ Shared Prompts Library
|
|
76
|
+
Access curated prompts as native slash commands (`/dot-ai:prompt-name`) in your coding agent for consistent workflows across projects.
|
|
77
|
+
π [Learn more β](./docs/mcp-prompts-guide.md)
|
|
141
78
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
π **Ready to deploy?** Jump to the [Quick Start](./docs/quick-start.md) guide to begin using DevOps AI Toolkit.
|
|
146
|
-
---
|
|
79
|
+
### β‘ AI Integration
|
|
80
|
+
Works with Claude Code, Cursor, VS Code via Model Context Protocol. Supports multiple AI providers (Claude, GPT, Gemini) for flexibility and cost optimization.
|
|
81
|
+
π [AI Model Configuration](./docs/mcp-setup.md#ai-model-configuration)
|
|
147
82
|
|
|
148
83
|
## See It In Action
|
|
149
84
|
|
|
@@ -151,42 +86,58 @@ DEVELOPER NOTE: This tool is under active development with incomplete functional
|
|
|
151
86
|
|
|
152
87
|
This video explains the platform engineering problem and demonstrates the Kubernetes deployment recommendation workflow from intent to running applications.
|
|
153
88
|
|
|
154
|
-
##
|
|
155
|
-
|
|
156
|
-
### π Getting Started
|
|
157
|
-
- **[MCP Setup Guide](docs/mcp-setup.md)** - Complete configuration instructions for AI tools integration
|
|
158
|
-
- **[Tools and Features Overview](docs/mcp-tools-overview.md)** - Comprehensive guide to all available tools and features
|
|
89
|
+
## Quick Start
|
|
159
90
|
|
|
160
|
-
|
|
91
|
+
Get started in 3 steps:
|
|
92
|
+
1. Configure MCP server (Docker or npm)
|
|
93
|
+
2. Connect your AI coding assistant (Claude Code, Cursor, VS Code)
|
|
94
|
+
3. Start using conversational workflows
|
|
161
95
|
|
|
162
|
-
|
|
96
|
+
## Documentation
|
|
163
97
|
|
|
164
|
-
|
|
165
|
-
-
|
|
166
|
-
-
|
|
167
|
-
-
|
|
98
|
+
### Getting Started
|
|
99
|
+
- **[Quick Start Guide](docs/quick-start.md)** - Get started in minutes
|
|
100
|
+
- **[MCP Setup Guide](docs/mcp-setup.md)** - Complete configuration instructions
|
|
101
|
+
- **[Tools Overview](docs/mcp-tools-overview.md)** - All available tools and features
|
|
168
102
|
|
|
169
|
-
|
|
170
|
-
-
|
|
171
|
-
-
|
|
172
|
-
-
|
|
103
|
+
### Feature Guides
|
|
104
|
+
- **[Resource Provisioning](docs/mcp-recommendation-guide.md)** - AI-powered deployment recommendations
|
|
105
|
+
- **[Capability Management](docs/mcp-capability-management-guide.md)** - Semantic resource discovery
|
|
106
|
+
- **[Issue Remediation](docs/mcp-remediate-guide.md)** - AI-powered troubleshooting
|
|
107
|
+
- **[Pattern Management](docs/pattern-management-guide.md)** - Organizational deployment patterns
|
|
108
|
+
- **[Policy Management](docs/policy-management-guide.md)** - Governance and compliance
|
|
109
|
+
- **[Project Setup](docs/mcp-project-setup-guide.md)** - Repository governance automation
|
|
173
110
|
|
|
174
111
|
## Support
|
|
175
112
|
|
|
176
|
-
- **
|
|
113
|
+
- **[Support Guide](SUPPORT.md)** - How to get help and where to ask questions
|
|
114
|
+
- **GitHub Issues**: [Bug reports and feature requests](https://github.com/vfarcic/dot-ai/issues)
|
|
115
|
+
- **GitHub Discussions**: [Community Q&A and discussions](https://github.com/vfarcic/dot-ai/discussions)
|
|
116
|
+
- **Troubleshooting**: See [Troubleshooting Guide](./docs/mcp-setup.md#troubleshooting) for common problems
|
|
117
|
+
|
|
118
|
+
## Contributing & Governance
|
|
177
119
|
|
|
178
|
-
|
|
120
|
+
We welcome contributions from the community! Please review:
|
|
179
121
|
|
|
180
|
-
|
|
181
|
-
-
|
|
182
|
-
-
|
|
183
|
-
-
|
|
184
|
-
-
|
|
122
|
+
- **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute code, docs, and ideas
|
|
123
|
+
- **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community standards and expectations
|
|
124
|
+
- **[Security Policy](SECURITY.md)** - How to report security vulnerabilities
|
|
125
|
+
- **[Governance](docs/GOVERNANCE.md)** - Project governance and decision-making
|
|
126
|
+
- **[Maintainers](docs/MAINTAINERS.md)** - Current project maintainers
|
|
127
|
+
- **[Roadmap](docs/ROADMAP.md)** - Project direction and priorities
|
|
185
128
|
|
|
186
129
|
## License
|
|
187
130
|
|
|
188
131
|
MIT License - see [LICENSE](LICENSE) file for details.
|
|
189
132
|
|
|
133
|
+
## Acknowledgments
|
|
134
|
+
|
|
135
|
+
DevOps AI Toolkit is built on:
|
|
136
|
+
- [Model Context Protocol](https://modelcontextprotocol.io/) for AI integration framework
|
|
137
|
+
- [Vercel AI SDK](https://sdk.vercel.ai/) for unified AI provider interface
|
|
138
|
+
- [Kubernetes](https://kubernetes.io/) for the cloud native foundation
|
|
139
|
+
- [CNCF](https://www.cncf.io/) for the cloud native ecosystem
|
|
140
|
+
|
|
190
141
|
---
|
|
191
142
|
|
|
192
|
-
**DevOps AI Toolkit** -
|
|
143
|
+
**DevOps AI Toolkit** - Making cloud native operations accessible through AI-powered intelligence.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vfarcic/dot-ai",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.119.0",
|
|
4
4
|
"description": "AI-powered development productivity platform that enhances software development workflows through intelligent automation and AI-driven assistance",
|
|
5
5
|
"mcpName": "io.github.vfarcic/dot-ai",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -118,6 +118,17 @@ Work through the PRD template focusing on project management, milestone tracking
|
|
|
118
118
|
|
|
119
119
|
**CRITICAL**: Steps 2-4 must happen in this exact order to avoid the chicken-and-egg problem of needing the issue ID for the filename.
|
|
120
120
|
|
|
121
|
+
### Step 5: Update ROADMAP.md (If It Exists)
|
|
122
|
+
|
|
123
|
+
After creating the PRD, check if `docs/ROADMAP.md` exists. If it does, add the new feature to the appropriate timeframe section based on PRD priority:
|
|
124
|
+
- **High Priority** β Short-term section
|
|
125
|
+
- **Medium Priority** β Medium-term section
|
|
126
|
+
- **Low Priority** β Long-term section
|
|
127
|
+
|
|
128
|
+
Format: `- [Brief feature description] (PRD #[issue-id])`
|
|
129
|
+
|
|
130
|
+
The ROADMAP.md update will be included in the commit at the end of the workflow (Option 2).
|
|
131
|
+
|
|
121
132
|
## Next Steps After PRD Creation
|
|
122
133
|
|
|
123
134
|
After completing the PRD, present the user with numbered options:
|
|
@@ -150,8 +161,10 @@ This will help identify the first task and set up the development workflow.
|
|
|
150
161
|
If user chooses option 2:
|
|
151
162
|
|
|
152
163
|
```bash
|
|
153
|
-
# Stage the PRD file
|
|
164
|
+
# Stage the PRD file (and ROADMAP.md if it was updated)
|
|
154
165
|
git add prds/[issue-id]-[feature-name].md
|
|
166
|
+
# If docs/ROADMAP.md exists and was updated, include it:
|
|
167
|
+
# git add docs/ROADMAP.md
|
|
155
168
|
|
|
156
169
|
# Commit with skip CI flag to avoid unnecessary CI runs
|
|
157
170
|
git commit -m "docs(prd-[issue-id]): create PRD #[issue-id] - [feature-name] [skip ci]
|
|
@@ -159,6 +172,7 @@ git commit -m "docs(prd-[issue-id]): create PRD #[issue-id] - [feature-name] [sk
|
|
|
159
172
|
- Created PRD for [brief feature description]
|
|
160
173
|
- Defined [X] major milestones
|
|
161
174
|
- Documented problem, solution, and success criteria
|
|
175
|
+
- Added to ROADMAP.md ([timeframe] section)
|
|
162
176
|
- Ready for implementation"
|
|
163
177
|
|
|
164
178
|
# Push to main
|
|
@@ -33,6 +33,7 @@ Complete the PRD implementation workflow including branch management, pull reque
|
|
|
33
33
|
- [ ] **No outstanding blockers**: All dependencies resolved and technical debt addressed
|
|
34
34
|
- [ ] **Update PRD status**: Mark PRD as "Complete" with completion date
|
|
35
35
|
- [ ] **Archive PRD file**: Move completed PRD to `./prds/done/` directory to maintain project organization
|
|
36
|
+
- [ ] **Update ROADMAP.md (if it exists)**: Remove the completed feature from `docs/ROADMAP.md` roadmap if the file exists
|
|
36
37
|
|
|
37
38
|
**Note**: Tests will run automatically in the CI/CD pipeline when the PR is created. Do not run tests locally during the completion workflow.
|
|
38
39
|
|
|
@@ -52,10 +53,191 @@ Complete the PRD implementation workflow including branch management, pull reque
|
|
|
52
53
|
- [ ] **Push to remote**: `git push -u origin feature/prd-[issue-id]-[feature-name]`
|
|
53
54
|
|
|
54
55
|
### 3. Pull Request Creation
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
56
|
+
|
|
57
|
+
**IMPORTANT: Always check for and use PR template if available**
|
|
58
|
+
|
|
59
|
+
#### 3.1. PR Template Detection and Parsing
|
|
60
|
+
- [ ] **Check for PR template** in common locations:
|
|
61
|
+
- `.github/PULL_REQUEST_TEMPLATE.md`
|
|
62
|
+
- `.github/pull_request_template.md`
|
|
63
|
+
- `.github/PULL_REQUEST_TEMPLATE/` (directory with multiple templates)
|
|
64
|
+
- `docs/pull_request_template.md`
|
|
65
|
+
|
|
66
|
+
- [ ] **Read and parse template comprehensively**: If found, analyze the template to extract:
|
|
67
|
+
- **Structural elements**: Required sections, checklists, format requirements
|
|
68
|
+
- **Content requirements**: What information needs to be provided in each section
|
|
69
|
+
- **Process instructions**: Any workflow enhancements or prerequisites specified in the template
|
|
70
|
+
- **Validation requirements**: Any checks, sign-offs, or verifications mentioned
|
|
71
|
+
|
|
72
|
+
- [ ] **Extract actionable instructions from template**:
|
|
73
|
+
- **Commit requirements**: Look for DCO sign-off, commit message format, commit signing requirements
|
|
74
|
+
- **Pre-submission actions**: Build commands, test commands, linting, format checks
|
|
75
|
+
- **Documentation requirements**: Which docs must be updated, links that must be added
|
|
76
|
+
- **Review requirements**: Required reviewers, approval processes, special considerations
|
|
77
|
+
|
|
78
|
+
**Examples of template instructions to identify and execute:**
|
|
79
|
+
- "All commits must include a `Signed-off-by` line" β Validate commits have DCO sign-off, amend if missing
|
|
80
|
+
- "Run `npm test` before submitting" β Execute test command
|
|
81
|
+
- "PR title follows Conventional Commits format" β Validate title format
|
|
82
|
+
- "Update CHANGELOG.md" β Check if changelog was updated
|
|
83
|
+
- Any bash commands shown in code blocks β Consider if they should be executed
|
|
84
|
+
|
|
85
|
+
#### 3.2. Analyze Changes for PR Content
|
|
86
|
+
- [ ] **Review git diff**: Analyze `git diff main...HEAD` to understand scope of changes
|
|
87
|
+
- [ ] **Review commit history**: Use `git log main..HEAD` to understand implementation progression
|
|
88
|
+
- [ ] **Identify change types**: Determine if changes include:
|
|
89
|
+
- New features, bug fixes, refactoring, documentation, tests, configuration, dependencies
|
|
90
|
+
- Breaking changes or backward-compatible changes
|
|
91
|
+
- Performance improvements or security fixes
|
|
92
|
+
- [ ] **Check modified files**: Identify which areas of codebase were affected
|
|
93
|
+
- Source code files
|
|
94
|
+
- Test files
|
|
95
|
+
- Documentation files
|
|
96
|
+
- Configuration files
|
|
97
|
+
|
|
98
|
+
#### 3.3. Auto-Fill PR Information
|
|
99
|
+
Automatically populate what can be deduced from analysis:
|
|
100
|
+
|
|
101
|
+
- [ ] **PR Title**:
|
|
102
|
+
- Follow template title format if specified (e.g., Conventional Commits: `feat(scope): description`)
|
|
103
|
+
- Extract from PRD title/description and commit messages
|
|
104
|
+
- Include issue reference if required by template
|
|
105
|
+
|
|
106
|
+
- [ ] **Description sections**:
|
|
107
|
+
- **What/Why**: Extract from PRD objectives and implementation details
|
|
108
|
+
- **Related issues**: Automatically link using `Closes #[issue-id]` or `Fixes #[issue-id]`
|
|
109
|
+
- **Type of change**: Check appropriate boxes based on file analysis
|
|
110
|
+
|
|
111
|
+
- [ ] **Testing checklist**:
|
|
112
|
+
- Mark "Tests added/updated" if test files were modified
|
|
113
|
+
- Note: Tests run in CI/CD automatically
|
|
114
|
+
|
|
115
|
+
- [ ] **Documentation checklist**:
|
|
116
|
+
- Mark items based on which docs were updated (README, API docs, code comments)
|
|
117
|
+
- Check if CONTRIBUTING.md guidelines followed
|
|
118
|
+
|
|
119
|
+
- [ ] **Security checklist**:
|
|
120
|
+
- Scan commits for potential secrets or credentials
|
|
121
|
+
- Flag if authentication/authorization code changed
|
|
122
|
+
- Note any dependency updates
|
|
123
|
+
|
|
124
|
+
#### 3.4. Prompt User for Information That Cannot Be Deduced
|
|
125
|
+
**IMPORTANT: Don't just ask - analyze and propose answers, then let user confirm or correct**
|
|
126
|
+
|
|
127
|
+
For each item, use available context to propose an answer, then present it to the user for confirmation:
|
|
128
|
+
|
|
129
|
+
- [ ] **Manual testing results**:
|
|
130
|
+
- **Analyze PRD testing strategy section** to understand what testing was planned
|
|
131
|
+
- **Check git commits** for testing-related messages
|
|
132
|
+
- **Propose testing approach** based on change type (e.g., "Documentation reviewed for accuracy and clarity, cross-references validated")
|
|
133
|
+
- Present proposal and ask: "Is this accurate, or would you like to modify?"
|
|
134
|
+
|
|
135
|
+
- [ ] **Breaking changes**:
|
|
136
|
+
- **Scan commits and PRD** for breaking change indicators
|
|
137
|
+
- If detected, **propose migration guidance** based on PRD content
|
|
138
|
+
- If not detected, **confirm**: "No breaking changes detected. Correct?"
|
|
139
|
+
|
|
140
|
+
- [ ] **Performance implications**:
|
|
141
|
+
- **Analyze change type**: Documentation/config changes typically have no performance impact
|
|
142
|
+
- **Propose answer** based on analysis (e.g., "No performance impact - documentation only")
|
|
143
|
+
- Ask: "Correct, or are there performance considerations?"
|
|
144
|
+
|
|
145
|
+
- [ ] **Security considerations**:
|
|
146
|
+
- **Check if security-sensitive files** were modified (auth, credentials, API keys)
|
|
147
|
+
- **Scan commits** for security-related keywords
|
|
148
|
+
- **Propose security status** (e.g., "No security implications - documentation changes only")
|
|
149
|
+
- Ask: "Accurate, or are there security considerations to document?"
|
|
150
|
+
|
|
151
|
+
- [ ] **Reviewer focus areas**:
|
|
152
|
+
- **Analyze PRD objectives** and **git changes** to identify key areas
|
|
153
|
+
- **Propose specific focus areas** (e.g., "Verify documentation accuracy, check cross-reference links, confirm workflow examples match implementation")
|
|
154
|
+
- Present list and ask: "Are these the right focus areas, or should I adjust?"
|
|
155
|
+
|
|
156
|
+
- [ ] **Follow-up work**:
|
|
157
|
+
- **Check PRD for "Future Enhancements" or "Out of Scope" sections**
|
|
158
|
+
- **Analyze other PRDs** in `prds/` directory for related work
|
|
159
|
+
- **Propose follow-up items** if any (e.g., "Future enhancements listed in PRD: template validation, AI-powered descriptions")
|
|
160
|
+
- Ask: "Should I list these, or is there other follow-up work?"
|
|
161
|
+
|
|
162
|
+
- [ ] **Additional context**:
|
|
163
|
+
- **Review PRD for special considerations**
|
|
164
|
+
- **Check if this is a dogfooding/testing PR**
|
|
165
|
+
- **Propose any relevant context** (e.g., "This PR itself tests the enhanced workflow it documents")
|
|
166
|
+
- Ask: "Anything else reviewers should know?"
|
|
167
|
+
|
|
168
|
+
**Presentation Format:**
|
|
169
|
+
Present all proposed answers together in a summary format:
|
|
170
|
+
```markdown
|
|
171
|
+
π **Proposed PR Information** (based on analysis)
|
|
172
|
+
|
|
173
|
+
**Manual Testing:** [proposed answer]
|
|
174
|
+
**Breaking Changes:** [proposed answer]
|
|
175
|
+
**Performance Impact:** [proposed answer]
|
|
176
|
+
**Security Considerations:** [proposed answer]
|
|
177
|
+
**Reviewer Focus:** [proposed list]
|
|
178
|
+
**Follow-up Work:** [proposed items or "None"]
|
|
179
|
+
**Additional Context:** [proposed context or "None"]
|
|
180
|
+
|
|
181
|
+
Please review and respond:
|
|
182
|
+
- Type "yes" or "confirm" to accept all
|
|
183
|
+
- Specify corrections for any items that need changes
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
#### 3.5. Execute Template Requirements
|
|
187
|
+
**IMPORTANT: Before creating the PR, identify and execute any actionable requirements from the template**
|
|
188
|
+
|
|
189
|
+
- [ ] **Analyze template for actionable instructions**:
|
|
190
|
+
- Scan template content for imperative statements, requirements, or commands
|
|
191
|
+
- Look for patterns like "must", "should", "run", "execute", "ensure", "verify"
|
|
192
|
+
- Identify bash commands in code blocks that appear to be prerequisites
|
|
193
|
+
- Extract any validation requirements mentioned in checklists
|
|
194
|
+
|
|
195
|
+
- [ ] **Categorize identified requirements**:
|
|
196
|
+
- **Commit-level actions**: Sign-offs, formatting, validation
|
|
197
|
+
- **Pre-submission commands**: Tests, builds, lints, format checks
|
|
198
|
+
- **Validation checks**: File existence, format compliance, content requirements
|
|
199
|
+
- **Documentation actions**: Required updates, links to add
|
|
200
|
+
|
|
201
|
+
- [ ] **Propose and execute requirements**:
|
|
202
|
+
- Present identified requirements to user: "Template specifies these actions: [list]"
|
|
203
|
+
- For each requirement, determine if it can be automated
|
|
204
|
+
- Propose execution: "Should I execute these now?"
|
|
205
|
+
- Execute confirmed actions and report results
|
|
206
|
+
- Handle failures gracefully and ask user how to proceed
|
|
207
|
+
|
|
208
|
+
- [ ] **Summary before PR creation**:
|
|
209
|
+
```markdown
|
|
210
|
+
β
Template Requirements Status:
|
|
211
|
+
[List each requirement with status: executed/validated/skipped/failed]
|
|
212
|
+
|
|
213
|
+
Ready to create PR? (yes/no)
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
#### 3.6. Create Pull Request
|
|
217
|
+
- [ ] **Construct PR body**: Combine auto-filled and user-provided information following template structure
|
|
218
|
+
- [ ] **Create PR**: Use `gh pr create --title "[title]" --body "[constructed-body]"` or `gh pr create --title "[title]" --body-file [temp-file]`
|
|
219
|
+
- [ ] **Verify PR created**: Confirm PR was created successfully and template was populated correctly
|
|
220
|
+
- [ ] **Request reviews**: Assign appropriate team members for code review if specified
|
|
221
|
+
|
|
222
|
+
#### 3.7. Fallback for Projects Without Templates
|
|
223
|
+
If no PR template is found, create a sensible default structure:
|
|
224
|
+
|
|
225
|
+
```markdown
|
|
226
|
+
## Description
|
|
227
|
+
[What this PR does and why]
|
|
228
|
+
|
|
229
|
+
## Related Issues
|
|
230
|
+
Closes #[issue-id]
|
|
231
|
+
|
|
232
|
+
## Changes Made
|
|
233
|
+
- [List key changes]
|
|
234
|
+
|
|
235
|
+
## Testing
|
|
236
|
+
- [Testing approach and results]
|
|
237
|
+
|
|
238
|
+
## Documentation
|
|
239
|
+
- [Documentation updates made]
|
|
240
|
+
```
|
|
59
241
|
|
|
60
242
|
### 4. Review and Merge Process
|
|
61
243
|
- [ ] **Check ongoing processes**: Use `gh pr checks [pr-number]` to check for any ongoing CI/CD, security analysis, or automated reviews (CodeRabbit, CodeQL, etc.)
|
|
@@ -10,6 +10,8 @@ category: project-management
|
|
|
10
10
|
|
|
11
11
|
You are helping initiate active implementation work on a specific Product Requirements Document (PRD). This command bridges the gap between PRD planning and actual development work by setting up the implementation context and providing clear next steps.
|
|
12
12
|
|
|
13
|
+
**IMPORTANT**: Do NOT include time estimates or effort estimates in your responses. Focus on task prioritization, dependencies, and clear next steps without speculating on duration.
|
|
14
|
+
|
|
13
15
|
## Process Overview
|
|
14
16
|
|
|
15
17
|
1. **Select Target PRD** - Ask user which PRD they want to implement
|
|
@@ -190,8 +192,6 @@ Present the implementation plan:
|
|
|
190
192
|
|
|
191
193
|
**Success criteria**: [How you'll know this task is complete]
|
|
192
194
|
|
|
193
|
-
**Estimated effort**: [Time estimate]
|
|
194
|
-
|
|
195
195
|
**Next steps after this**: [What becomes possible once this is done]
|
|
196
196
|
|
|
197
197
|
## Implementation Approach
|