-
Notifications
You must be signed in to change notification settings - Fork 673
Collection category #135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
craigbekker
wants to merge
5
commits into
github:main
Choose a base branch
from
craigbekker:cb-plan-collection
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,661
−29
Open
Collection category #135
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
38d67f3
feat: Add collections support with plan collection
craigbekker 70ff58f
chore: remove obsolete test instructions and demo prompt files
craigbekker 1d28548
Refactor planning prompts:
craigbekker 6486a8a
feat: Update README and script to include Collections in customizatio…
craigbekker 41ea873
Update README.md
craigbekker File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # 🎯 Plan Collection | ||
|
|
||
| A curated collection of GitHub Copilot customizations focused on plan workflows and best practices. | ||
|
|
||
| ## 📄 About This Collection | ||
|
|
||
| This collection provides specialized prompts, instructions, and chat modes tailored for plan-related development tasks. | ||
|
|
||
| ## 🎯 Prompts | ||
|
|
||
| Ready-to-use prompt templates for this collection: | ||
|
|
||
| | Title | Description | Install | | ||
| | ----- | ----------- | ------- | | ||
| | [Epic Architecture Specification Prompt](prompts/plan-epic-arch.prompt.md) | Prompt for creating the high-level technical architecture for an Epic, based on a Product Requirements Document. | [](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-epic-arch.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-epic-arch.prompt.md) | | ||
| | [Epic Product Requirements Document (PRD) Prompt](prompts/plan-epic-pm.prompt.md) | Prompt for creating an Epic Product Requirements Document (PRD) for a new epic. This PRD will be used as input for generating a technical architecture specification. | [](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-epic-pm.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-epic-pm.prompt.md) | | ||
| | [Feature Implementation Plan Prompt](prompts/plan-feature-implementation.prompt.md) | Prompt for creating detailed feature implementation plans, following Epoch monorepo structure. | [](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-feature-implementation.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-feature-implementation.prompt.md) | | ||
| | [Feature PRD Prompt](prompts/plan-feature-prd.prompt.md) | Prompt for creating Product Requirements Documents (PRDs) for new features, based on an Epic. | [](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-feature-prd.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-feature-prd.prompt.md) | | ||
| | [GitHub Issue Planning & Project Automation Prompt](prompts/plan-github.prompt.md) | Issue Planning and Automation prompt that generates comprehensive project plans with Epic > Feature > Story/Enabler > Test hierarchy, dependencies, priorities, and automated tracking. | [](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-github.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-github.prompt.md) | | ||
| | [Test Planning & Quality Assurance Prompt](prompts/plan-test.prompt.md) | Test Planning and Quality Assurance prompt that generates comprehensive test strategies, task breakdowns, and quality validation plans for GitHub projects. | [](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-test.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fcollections%2Fplan%2Fprompts%2Fplan-test.prompt.md) | | ||
|
|
||
| > 💡 **Usage**: Use `/prompt-name` in VS Code chat, run `Chat: Run Prompt` command, or hit the run button while you have a prompt open. | ||
|
|
||
| ## 🔗 Related | ||
|
|
||
| - [Main Repository](../../) - Browse all available customizations | ||
| - [Contributing Guide](../../CONTRIBUTING.md) - How to contribute to this collection |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| # GitHub Copilot Prompt Library | ||
|
|
||
| This directory contains specialized prompt files designed to work with GitHub Copilot to streamline the development process using a comprehensive hierarchical breakdown approach. | ||
|
|
||
| ## Core Planning Workflow | ||
|
|
||
| This streamlined workflow covers the essential planning stages from epic definition through project management setup, with integrated testing and quality assurance. | ||
|
|
||
| ### Hierarchical Work Breakdown Structure | ||
|
|
||
| Our workflow follows the Agile hierarchy: **Epic → Feature → Implementation → Project Management**, with each level providing specific value and granularity: | ||
|
|
||
| - **Epic**: Large business capability spanning multiple features (milestone level) | ||
| - **Feature**: Deliverable user-facing functionality within an epic | ||
| - **Implementation**: Technical planning and architecture for feature delivery | ||
| - **Project Management**: GitHub issues, automation, and delivery tracking | ||
|
|
||
| --- | ||
|
|
||
| ## Streamlined Development Flow | ||
|
|
||
| ```mermaid | ||
| graph LR | ||
| A[Epic PRD] --> B[Epic Architecture] | ||
| B --> C[Feature PRD] | ||
| C --> D[Feature Implementation Plan] | ||
| D --> E[GitHub Project Setup] | ||
|
|
||
| subgraph "Core Planning Chain" | ||
| G["Epic → Feature → Implementation"] | ||
| H["Project Management"] | ||
| end | ||
| ``` | ||
|
|
||
| ### Input/Output Chain | ||
|
|
||
| 1. **Epic PRD** → Business requirements and scope definition | ||
| 2. **Epic Architecture** → High-level technical approach and system design | ||
| 3. **Feature PRD** → Detailed feature specifications and user requirements | ||
| 4. **Feature Implementation** → Technical planning and development approach | ||
| 5. **GitHub Project Setup** → Automated project management and tracking | ||
|
|
||
| --- | ||
|
|
||
| ## Step-by-Step Execution Guide | ||
|
|
||
| ### 1. Epic Definition (Product Management) | ||
|
|
||
| - Use `plan-epic-pm.prompt.md` to create an Epic PRD | ||
| - **Input:** High-level epic idea or business requirement | ||
| - **Output:** `/docs/ways-of-work/plan/epic/{epic-name}.md` | ||
|
|
||
| ### 2. Epic Architecture (Technical Leadership) | ||
|
|
||
| - Use `plan-epic-arch.prompt.md` with the Epic PRD to define technical architecture | ||
| - **Input:** Epic PRD from step 1 | ||
| - **Output:** `/docs/ways-of-work/plan/epic/{epic-name}-arch.md` | ||
|
|
||
| ### 3. Feature Definition (Product Management) | ||
|
|
||
| - Use `plan-feature-prd.prompt.md` for each feature in the epic | ||
| - **Input:** Epic PRD and Epic Architecture | ||
| - **Output:** `/docs/ways-of-work/plan/{epic-name}/{feature-name}.md` | ||
|
|
||
| ### 4. Feature Implementation Planning (Engineering) | ||
|
|
||
| - Use `plan-feature-implementation.prompt.md` to create technical implementation plan | ||
| - **Input:** Feature PRD and Epic Architecture | ||
| - **Output:** `/docs/ways-of-work/plan/{epic-name}/{feature-name}/implementation-plan.md` | ||
|
|
||
| ### 5. GitHub Project Setup (Project Management) | ||
|
|
||
| - Use `plan-github.prompt.md` to generate automated project management and issue tracking | ||
| - **Input:** Epic PRD, Epic Architecture, Feature PRD, Implementation Plan | ||
| - **Output:** `/docs/ways-of-work/plan/{epic-name}/{feature-name}/project-plan.md` | ||
|
|
||
| --- | ||
|
|
||
| ## Best Practices | ||
|
|
||
| - **Sequential Execution**: Follow the step-by-step guide in order for optimal results | ||
| - **Document Attachment**: Always attach required input documents as specified in each prompt | ||
| - **File Path Consistency**: Use absolute file paths for referencing outputs | ||
| - **Version Control**: Maintain version control for all planning artifacts | ||
| - **Review and Validate**: Review outputs before using as inputs for subsequent steps | ||
| - **Iterative Refinement**: Use feedback loops to improve planning quality | ||
|
|
||
| --- | ||
|
|
||
| ## Available Prompts | ||
|
|
||
| - **plan-epic-pm.prompt.md** – Epic Product Requirements Document | ||
| - **plan-epic-arch.prompt.md** – Epic Technical Architecture Specification | ||
| - **plan-feature-prd.prompt.md** – Feature Product Requirements Document | ||
| - **plan-feature-implementation.prompt.md** – Feature Technical Implementation Plan | ||
| - **plan-test.prompt.md** – Comprehensive Test Strategy (ISTQB & ISO 25010) - wip | ||
| - **plan-github.prompt.md** – GitHub Project Management and Issue Planning | ||
|
|
||
| --- | ||
|
|
||
| ## AI Agent Integration & Automation | ||
|
|
||
| - **Sequential Planning**: Copilot-driven workflow execution from epic to project management | ||
| - **Document Chain Integration**: Each prompt builds on previous outputs for complete traceability | ||
| - **Quality Gate Automation**: ISTQB framework integration with automated validation | ||
| - **GitHub Integration**: Automated project setup and issue tracking from planning artifacts | ||
| - **Multi-Modal Planning**: Business, technical, testing, and project management perspectives | ||
| - **Artifact Management**: Structured file output with consistent naming and organization | ||
|
|
||
| --- | ||
|
|
||
| ## Simplified Workflow Pattern | ||
|
|
||
| - **Epic Level**: Define business capability and technical architecture | ||
| - **Feature Level**: Detailed requirements and implementation planning | ||
| - **Project Level**: Comprehensive testing strategy and project management setup | ||
|
|
||
| The process provides **complete traceability** from high-level business goals down to specific implementation plans and quality validation, with automated project management integration. | ||
|
|
||
| --- | ||
|
|
||
| ## Usage Patterns | ||
|
|
||
| ### Complete Epic Planning | ||
|
|
||
| 1. Epic PRD → Epic Architecture → Feature PRD → Implementation → Project Setup | ||
|
|
||
| ### Feature-Focused Planning | ||
|
|
||
| 1. Feature PRD → Implementation Plan → GitHub Setup | ||
|
|
||
| ### Project Management Setup | ||
|
|
||
| 1. Gather all artifacts → GitHub Project Planning → Automated issue creation | ||
|
|
||
| --- | ||
|
|
||
| This streamlined planning workflow provides complete coverage from business requirements through technical implementation and quality assurance, with integrated project management automation for efficient delivery tracking. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| mode: 'agent' | ||
| description: 'Prompt for creating the high-level technical architecture for an Epic, based on a Product Requirements Document.' | ||
| --- | ||
|
|
||
| # Epic Architecture Specification Prompt | ||
|
|
||
| ## Goal | ||
|
|
||
| Act as a Senior Software Architect. Your task is to take an Epic PRD and create a high-level technical architecture specification. This document will guide the development of the epic, outlining the major components, features, and technical enablers required. | ||
|
|
||
| ## Context Considerations | ||
|
|
||
| - The Epic PRD from the Product Manager. | ||
| - **Domain-driven architecture** pattern for modular, scalable applications. | ||
| - **Self-hosted and SaaS deployment** requirements. | ||
| - **Docker containerization** for all services. | ||
| - **TypeScript/Next.js** stack with App Router. | ||
| - **Turborepo monorepo** patterns. | ||
| - **tRPC** for type-safe APIs. | ||
| - **Stack Auth** for authentication. | ||
|
|
||
| **Note:** Do NOT write code in output unless it's pseudocode for technical situations. | ||
|
|
||
| ## Output Format | ||
|
|
||
| The output should be a complete Epic Architecture Specification in Markdown format, saved to `/docs/ways-of-work/plan/{epic-name}/arch.md`. | ||
|
|
||
| ### Specification Structure | ||
|
|
||
| #### 1. Epic Architecture Overview | ||
|
|
||
| - A brief summary of the technical approach for the epic. | ||
|
|
||
| #### 2. System Architecture Diagram | ||
|
|
||
| Create a comprehensive Mermaid diagram that illustrates the complete system architecture for this epic. The diagram should include: | ||
|
|
||
| - **User Layer**: Show how different user types (web browsers, mobile apps, admin interfaces) interact with the system | ||
| - **Application Layer**: Depict load balancers, application instances, and authentication services (Stack Auth) | ||
| - **Service Layer**: Include tRPC APIs, background services, workflow engines (n8n), and any epic-specific services | ||
| - **Data Layer**: Show databases (PostgreSQL), vector databases (Qdrant), caching layers (Redis), and external API integrations | ||
| - **Infrastructure Layer**: Represent Docker containerization and deployment architecture | ||
|
|
||
| Use clear subgraphs to organize these layers, apply consistent color coding for different component types, and show the data flow between components. Include both synchronous request paths and asynchronous processing flows where relevant to the epic. | ||
|
|
||
| #### 3. High-Level Features & Technical Enablers | ||
|
|
||
| - A list of the high-level features to be built. | ||
| - A list of technical enablers (e.g., new services, libraries, infrastructure) required to support the features. | ||
|
|
||
| #### 4. Technology Stack | ||
|
|
||
| - A list of the key technologies, frameworks, and libraries to be used. | ||
|
|
||
| #### 5. Technical Value | ||
|
|
||
| - Estimate the technical value (e.g., High, Medium, Low) with a brief justification. | ||
|
|
||
| #### 6. T-Shirt Size Estimate | ||
|
|
||
| - Provide a high-level t-shirt size estimate for the epic (e.g., S, M, L, XL). | ||
|
|
||
| ## Context Template | ||
|
|
||
| - **Epic PRD:** [The content of the Epic PRD markdown file] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.