mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 02:15:12 +00:00
Merge branch 'main' into main
This commit is contained in:
Noah Jenkins
GitHub
72
.github/plugin/marketplace.json
vendored
72
.github/plugin/marketplace.json
vendored
@@ -19,7 +19,7 @@
|
||||
{
|
||||
"name": "azure-cloud-development",
|
||||
"source": "./plugins/azure-cloud-development",
|
||||
"description": "Azure cloud development tools including Infrastructure as Code, architecture patterns, and cost optimization.",
|
||||
"description": "Comprehensive Azure cloud development tools including Infrastructure as Code, serverless functions, architecture patterns, and cost optimization for building scalable cloud applications.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -34,10 +34,16 @@
|
||||
"description": "Tools for REPL-first Clojure workflows featuring Clojure instructions, the interactive programming chat mode and supporting guidance.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "context-engineering",
|
||||
"source": "./plugins/context-engineering",
|
||||
"description": "Tools and techniques for maximizing GitHub Copilot effectiveness through better context management. Includes guidelines for structuring code, an agent for planning multi-file changes, and prompts for context-aware development.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "copilot-sdk",
|
||||
"source": "./plugins/copilot-sdk",
|
||||
"description": "Build applications with the GitHub Copilot SDK across multiple programming languages. Includes comprehensive instructions for C#, Go, Node.js/TypeScript, and Python.",
|
||||
"description": "Build applications with the GitHub Copilot SDK across multiple programming languages. Includes comprehensive instructions for C#, Go, Node.js/TypeScript, and Python to help you create AI-powered applications.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -49,7 +55,7 @@
|
||||
{
|
||||
"name": "csharp-mcp-development",
|
||||
"source": "./plugins/csharp-mcp-development",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in C# using the official SDK.",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in C# using the official SDK. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -61,7 +67,7 @@
|
||||
{
|
||||
"name": "dataverse-sdk-for-python",
|
||||
"source": "./plugins/dataverse-sdk-for-python",
|
||||
"description": "Comprehensive collection for building production-ready Python integrations with Microsoft Dataverse.",
|
||||
"description": "Comprehensive collection for building production-ready Python integrations with Microsoft Dataverse. Includes official documentation, best practices, advanced features, file operations, and code generation prompts.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -82,10 +88,16 @@
|
||||
"description": "Essential prompts, instructions, and chat modes for modern frontend web development including React, Angular, Vue, TypeScript, and CSS frameworks.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "gem-team",
|
||||
"source": "./plugins/gem-team",
|
||||
"description": "A modular multi-agent team for complex project execution with DAG-based planning, parallel execution, TDD verification, and automated testing.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "go-mcp-development",
|
||||
"source": "./plugins/go-mcp-development",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in Go using the official github.com/modelcontextprotocol/go-sdk.",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in Go using the official github.com/modelcontextprotocol/go-sdk. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -103,91 +115,97 @@
|
||||
{
|
||||
"name": "kotlin-mcp-development",
|
||||
"source": "./plugins/kotlin-mcp-development",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in Kotlin using the official io.modelcontextprotocol:kotlin-sdk library.",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in Kotlin using the official io.modelcontextprotocol:kotlin-sdk library. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "mcp-m365-copilot",
|
||||
"source": "./plugins/mcp-m365-copilot",
|
||||
"description": "Comprehensive collection for building declarative agents with Model Context Protocol integration for Microsoft 365 Copilot.",
|
||||
"description": "Comprehensive collection for building declarative agents with Model Context Protocol integration for Microsoft 365 Copilot",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "openapi-to-application-csharp-dotnet",
|
||||
"source": "./plugins/openapi-to-application-csharp-dotnet",
|
||||
"description": "Generate production-ready .NET applications from OpenAPI specifications. Includes ASP.NET Core project scaffolding, controller generation, and entity framework integration.",
|
||||
"description": "Generate production-ready .NET applications from OpenAPI specifications. Includes ASP.NET Core project scaffolding, controller generation, entity framework integration, and C# best practices.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "openapi-to-application-go",
|
||||
"source": "./plugins/openapi-to-application-go",
|
||||
"description": "Generate production-ready Go applications from OpenAPI specifications. Includes project scaffolding, handler generation, middleware setup, and Go best practices.",
|
||||
"description": "Generate production-ready Go applications from OpenAPI specifications. Includes project scaffolding, handler generation, middleware setup, and Go best practices for REST APIs.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "openapi-to-application-java-spring-boot",
|
||||
"source": "./plugins/openapi-to-application-java-spring-boot",
|
||||
"description": "Generate production-ready Spring Boot applications from OpenAPI specifications. Includes project scaffolding, REST controller generation, and service layer organization.",
|
||||
"description": "Generate production-ready Spring Boot applications from OpenAPI specifications. Includes project scaffolding, REST controller generation, service layer organization, and Spring Boot best practices.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "openapi-to-application-nodejs-nestjs",
|
||||
"source": "./plugins/openapi-to-application-nodejs-nestjs",
|
||||
"description": "Generate production-ready NestJS applications from OpenAPI specifications. Includes project scaffolding, controller and service generation, and TypeScript best practices.",
|
||||
"description": "Generate production-ready NestJS applications from OpenAPI specifications. Includes project scaffolding, controller and service generation, TypeScript best practices, and enterprise patterns.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "openapi-to-application-python-fastapi",
|
||||
"source": "./plugins/openapi-to-application-python-fastapi",
|
||||
"description": "Generate production-ready FastAPI applications from OpenAPI specifications. Includes project scaffolding, route generation, and dependency injection.",
|
||||
"description": "Generate production-ready FastAPI applications from OpenAPI specifications. Includes project scaffolding, route generation, dependency injection, and Python best practices for async APIs.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "ospo-sponsorship",
|
||||
"source": "./plugins/ospo-sponsorship",
|
||||
"description": "Tools and resources for Open Source Program Offices (OSPOs) to identify, evaluate, and manage sponsorship of open source dependencies through GitHub Sponsors, Open Collective, and other funding platforms.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "partners",
|
||||
"source": "./plugins/partners",
|
||||
"description": "Custom agents that have been created by GitHub partners.",
|
||||
"description": "Custom agents that have been created by GitHub partners",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "pcf-development",
|
||||
"source": "./plugins/pcf-development",
|
||||
"description": "Complete toolkit for developing custom code components using Power Apps Component Framework for model-driven and canvas apps.",
|
||||
"description": "Complete toolkit for developing custom code components using Power Apps Component Framework for model-driven and canvas apps",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "php-mcp-development",
|
||||
"source": "./plugins/php-mcp-development",
|
||||
"description": "Comprehensive resources for building Model Context Protocol servers using the official PHP SDK with attribute-based discovery.",
|
||||
"description": "Comprehensive resources for building Model Context Protocol servers using the official PHP SDK with attribute-based discovery, including best practices, project generation, and expert assistance",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "power-apps-code-apps",
|
||||
"source": "./plugins/power-apps-code-apps",
|
||||
"description": "Complete toolkit for Power Apps Code Apps development including project scaffolding, development standards, and expert guidance.",
|
||||
"description": "Complete toolkit for Power Apps Code Apps development including project scaffolding, development standards, and expert guidance for building code-first applications with Power Platform integration.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "power-bi-development",
|
||||
"source": "./plugins/power-bi-development",
|
||||
"description": "Comprehensive Power BI development resources including data modeling, DAX optimization, performance tuning, and visualization design.",
|
||||
"description": "Comprehensive Power BI development resources including data modeling, DAX optimization, performance tuning, visualization design, security best practices, and DevOps/ALM guidance for building enterprise-grade Power BI solutions.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "power-platform-mcp-connector-development",
|
||||
"source": "./plugins/power-platform-mcp-connector-development",
|
||||
"description": "Complete toolkit for developing Power Platform custom connectors with Model Context Protocol integration for Microsoft Copilot Studio.",
|
||||
"description": "Complete toolkit for developing Power Platform custom connectors with Model Context Protocol integration for Microsoft Copilot Studio",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "project-planning",
|
||||
"source": "./plugins/project-planning",
|
||||
"description": "Tools and guidance for software project planning, feature breakdown, epic management, implementation planning, and task organization.",
|
||||
"description": "Tools and guidance for software project planning, feature breakdown, epic management, implementation planning, and task organization for development teams.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "python-mcp-development",
|
||||
"source": "./plugins/python-mcp-development",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in Python using the official SDK with FastMCP.",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in Python using the official SDK with FastMCP. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -199,13 +217,13 @@
|
||||
{
|
||||
"name": "rust-mcp-development",
|
||||
"source": "./plugins/rust-mcp-development",
|
||||
"description": "Build high-performance Model Context Protocol servers in Rust using the official rmcp SDK with async/await and procedural macros.",
|
||||
"description": "Build high-performance Model Context Protocol servers in Rust using the official rmcp SDK with async/await, procedural macros, and type-safe implementations.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "security-best-practices",
|
||||
"source": "./plugins/security-best-practices",
|
||||
"description": "Security frameworks, accessibility guidelines, performance optimization, and code quality best practices.",
|
||||
"description": "Security frameworks, accessibility guidelines, performance optimization, and code quality best practices for building secure, maintainable, and high-performance applications.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -217,7 +235,7 @@
|
||||
{
|
||||
"name": "structured-autonomy",
|
||||
"source": "./plugins/structured-autonomy",
|
||||
"description": "Premium planning, thrifty implementation.",
|
||||
"description": "Premium planning, thrifty implementation",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
@@ -229,25 +247,25 @@
|
||||
{
|
||||
"name": "technical-spike",
|
||||
"source": "./plugins/technical-spike",
|
||||
"description": "Tools for creation, management and research of technical spikes to reduce unknowns and assumptions before specification and implementation.",
|
||||
"description": "Tools for creation, management and research of technical spikes to reduce unknowns and assumptions before proceeding to specification and implementation of solutions.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "testing-automation",
|
||||
"source": "./plugins/testing-automation",
|
||||
"description": "Comprehensive collection for writing tests, test automation, and TDD including unit tests, integration tests, and end-to-end testing.",
|
||||
"description": "Comprehensive collection for writing tests, test automation, and test-driven development including unit tests, integration tests, and end-to-end testing strategies.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "typescript-mcp-development",
|
||||
"source": "./plugins/typescript-mcp-development",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in TypeScript/Node.js using the official SDK.",
|
||||
"description": "Complete toolkit for building Model Context Protocol (MCP) servers in TypeScript/Node.js using the official SDK. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance.",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
{
|
||||
"name": "typespec-m365-copilot",
|
||||
"source": "./plugins/typespec-m365-copilot",
|
||||
"description": "Comprehensive collection of prompts, instructions, and resources for building declarative agents and API plugins using TypeSpec for Microsoft 365 Copilot.",
|
||||
"description": "Comprehensive collection of prompts, instructions, and resources for building declarative agents and API plugins using TypeSpec for Microsoft 365 Copilot extensibility.",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
|
||||
1
.github/workflows/validate-readme.yml
vendored
1
.github/workflows/validate-readme.yml
vendored
@@ -8,6 +8,7 @@ on:
|
||||
- "prompts/**"
|
||||
- "agents/**"
|
||||
- "collections/**"
|
||||
- "plugins/**"
|
||||
- "*.js"
|
||||
- "README.md"
|
||||
- "docs/**"
|
||||
|
||||
33
AGENTS.md
33
AGENTS.md
@@ -32,9 +32,12 @@ The Awesome GitHub Copilot repository is a community-driven collection of custom
|
||||
# Install dependencies
|
||||
npm ci
|
||||
|
||||
# Build the project (generates README.md)
|
||||
# Build the project (generates README.md and marketplace.json)
|
||||
npm run build
|
||||
|
||||
# Generate marketplace.json only
|
||||
npm run plugin:generate-marketplace
|
||||
|
||||
# Validate collection manifests
|
||||
npm run collection:validate
|
||||
|
||||
@@ -93,9 +96,18 @@ All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction fi
|
||||
- Follow the [GitHub Copilot hooks specification](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks)
|
||||
- Optionally includes `tags` field for categorization
|
||||
|
||||
#### Plugin Folders (plugins/*)
|
||||
- Each plugin is a folder containing a `.github/plugin/plugin.json` file with metadata
|
||||
- plugin.json must have `name` field (matching the folder name)
|
||||
- plugin.json must have `description` field (describing the plugin's purpose)
|
||||
- plugin.json must have `version` field (semantic version, e.g., "1.0.0")
|
||||
- Plugin folders can contain any combination of agents, prompts, instructions, skills, and hooks
|
||||
- The `marketplace.json` file is automatically generated from all plugins during build
|
||||
- Plugins are discoverable and installable via GitHub Copilot CLI
|
||||
|
||||
### Adding New Resources
|
||||
|
||||
When adding a new agent, prompt, instruction, skill, or hook:
|
||||
When adding a new agent, prompt, instruction, skill, hook, or plugin:
|
||||
|
||||
**For Agents, Prompts, and Instructions:**
|
||||
1. Create the file with proper front matter
|
||||
@@ -121,6 +133,14 @@ When adding a new agent, prompt, instruction, skill, or hook:
|
||||
5. Update the README.md by running: `npm run build`
|
||||
6. Verify the skill appears in the generated README
|
||||
|
||||
**For Plugins:**
|
||||
1. Create a new folder in `plugins/` with a descriptive name (lowercase with hyphens)
|
||||
2. Create `.github/plugin/plugin.json` with metadata (name, description, version)
|
||||
3. Add agents, prompts, instructions, skills, or hooks to the plugin folder
|
||||
4. Run `npm run build` to update README.md and marketplace.json
|
||||
5. Verify the plugin appears in `.github/plugin/marketplace.json`
|
||||
6. Test plugin installation: `copilot plugin install <plugin-name>@awesome-copilot`
|
||||
|
||||
### Testing Instructions
|
||||
|
||||
```bash
|
||||
@@ -219,6 +239,15 @@ For hook folders (hooks/*/):
|
||||
- [ ] Follows [GitHub Copilot hooks specification](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks)
|
||||
- [ ] Optionally includes `tags` array field for categorization
|
||||
|
||||
For plugin folders (plugins/*/):
|
||||
- [ ] Folder contains a `.github/plugin/plugin.json` file with metadata
|
||||
- [ ] plugin.json has `name` field matching folder name (lowercase with hyphens)
|
||||
- [ ] plugin.json has non-empty `description` field
|
||||
- [ ] plugin.json has `version` field (semantic version, e.g., "1.0.0")
|
||||
- [ ] Folder name is lower case with hyphens
|
||||
- [ ] Plugin resources (agents, prompts, etc.) follow their respective guidelines
|
||||
- [ ] Run `npm run build` to verify marketplace.json is updated correctly
|
||||
|
||||
## Contributing
|
||||
|
||||
This is a community-driven project. Contributions are welcome! Please see:
|
||||
|
||||
15
collections/ospo-sponsorship.collection.yml
Normal file
15
collections/ospo-sponsorship.collection.yml
Normal file
@@ -0,0 +1,15 @@
|
||||
id: ospo-sponsorship
|
||||
name: Open Source Sponsorship
|
||||
description: Tools and resources for Open Source Program Offices (OSPOs) to identify, evaluate, and manage sponsorship of open source dependencies through GitHub Sponsors, Open Collective, and other funding platforms.
|
||||
tags: [ospo, sponsorship, open-source, funding, github-sponsors]
|
||||
items:
|
||||
# Agent Skills
|
||||
- path: skills/sponsor-finder/SKILL.md
|
||||
kind: skill
|
||||
usage: |
|
||||
Find which of a GitHub repository's dependencies are sponsorable via GitHub Sponsors.
|
||||
Invoke by providing a GitHub owner/repo (e.g., "find sponsorable dependencies in expressjs/express").
|
||||
display:
|
||||
ordering: alpha # or "manual" to preserve the order above
|
||||
show_badge: true # set to true to show collection badge on items
|
||||
featured: false
|
||||
22
collections/ospo-sponsorship.md
Normal file
22
collections/ospo-sponsorship.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Open Source Sponsorship
|
||||
|
||||
Tools and resources for Open Source Program Offices (OSPOs) to identify, evaluate, and manage sponsorship of open source dependencies through GitHub Sponsors, Open Collective, and other funding platforms.
|
||||
|
||||
**Tags:** ospo, sponsorship, open-source, funding, github-sponsors
|
||||
|
||||
## Items in this Collection
|
||||
|
||||
| Title | Type | Description |
|
||||
| ----- | ---- | ----------- |
|
||||
| [Sponsor Finder](../skills/sponsor-finder/SKILL.md) | Skill | Find which of a GitHub repository's dependencies are sponsorable via GitHub Sponsors. Uses deps.dev API for dependency resolution across npm, PyPI, Cargo, Go, RubyGems, Maven, and NuGet. Checks npm funding metadata, FUNDING.yml files, and web search. Verifies every link. Shows direct and transitive dependencies with OSSF Scorecard health data. Invoke by providing a GitHub owner/repo (e.g. "find sponsorable dependencies in expressjs/express"). [see usage](#sponsor-finder) |
|
||||
|
||||
## Collection Usage
|
||||
|
||||
### Sponsor Finder
|
||||
|
||||
Find which of a GitHub repository's dependencies are sponsorable via GitHub Sponsors.
|
||||
Invoke by providing a GitHub owner/repo (e.g., "find sponsorable dependencies in expressjs/express").
|
||||
|
||||
---
|
||||
|
||||
*This collection includes 1 curated items for **Open Source Sponsorship**.*
|
||||
@@ -35,6 +35,7 @@ Curated collections of related prompts, instructions, and agents organized aroun
|
||||
| [Java MCP Server Development](../collections/java-mcp-development.md) | Complete toolkit for building Model Context Protocol servers in Java using the official MCP Java SDK with reactive streams and Spring Boot integration. | 3 items | java, mcp, model-context-protocol, server-development, sdk, reactive-streams, spring-boot, reactor |
|
||||
| [Kotlin MCP Server Development](../collections/kotlin-mcp-development.md) | Complete toolkit for building Model Context Protocol (MCP) servers in Kotlin using the official io.modelcontextprotocol:kotlin-sdk library. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance. | 3 items | kotlin, mcp, model-context-protocol, kotlin-multiplatform, server-development, ktor |
|
||||
| [MCP-based M365 Agents](../collections/mcp-m365-copilot.md) | Comprehensive collection for building declarative agents with Model Context Protocol integration for Microsoft 365 Copilot | 5 items | mcp, m365-copilot, declarative-agents, api-plugins, model-context-protocol, adaptive-cards |
|
||||
| [Open Source Sponsorship](../collections/ospo-sponsorship.md) | Tools and resources for Open Source Program Offices (OSPOs) to identify, evaluate, and manage sponsorship of open source dependencies through GitHub Sponsors, Open Collective, and other funding platforms. | 1 items | ospo, sponsorship, open-source, funding, github-sponsors |
|
||||
| [OpenAPI to Application - C# .NET](../collections/openapi-to-application-csharp-dotnet.md) | Generate production-ready .NET applications from OpenAPI specifications. Includes ASP.NET Core project scaffolding, controller generation, entity framework integration, and C# best practices. | 3 items | openapi, code-generation, api, csharp, dotnet, aspnet |
|
||||
| [OpenAPI to Application - Go](../collections/openapi-to-application-go.md) | Generate production-ready Go applications from OpenAPI specifications. Includes project scaffolding, handler generation, middleware setup, and Go best practices for REST APIs. | 3 items | openapi, code-generation, api, go, golang |
|
||||
| [OpenAPI to Application - Java Spring Boot](../collections/openapi-to-application-java-spring-boot.md) | Generate production-ready Spring Boot applications from OpenAPI specifications. Includes project scaffolding, REST controller generation, service layer organization, and Spring Boot best practices. | 3 items | openapi, code-generation, api, java, spring-boot |
|
||||
|
||||
@@ -31,6 +31,7 @@ Skills differ from other primitives by supporting bundled assets (scripts, code
|
||||
| [azure-role-selector](../skills/azure-role-selector/SKILL.md) | When user is asking for guidance for which role to assign to an identity given desired permissions, this agent helps them understand the role that will meet the requirements with least privilege access and how to apply that role. | `LICENSE.txt` |
|
||||
| [azure-static-web-apps](../skills/azure-static-web-apps/SKILL.md) | Helps create, configure, and deploy Azure Static Web Apps using the SWA CLI. Use when deploying static sites to Azure, setting up SWA local development, configuring staticwebapp.config.json, adding Azure Functions APIs to SWA, or setting up GitHub Actions CI/CD for Static Web Apps. | None |
|
||||
| [chrome-devtools](../skills/chrome-devtools/SKILL.md) | Expert-level browser automation, debugging, and performance analysis using Chrome DevTools MCP. Use for interacting with web pages, capturing screenshots, analyzing network traffic, and profiling performance. | None |
|
||||
| [copilot-cli-quickstart](../skills/copilot-cli-quickstart/SKILL.md) | Use this skill when someone wants to learn GitHub Copilot CLI from scratch. Offers interactive step-by-step tutorials with separate Developer and Non-Developer tracks, plus on-demand Q&A. Just say "start tutorial" or ask a question! Note: This skill targets GitHub Copilot CLI specifically and uses CLI-specific tools (ask_user, sql, fetch_copilot_cli_documentation). | None |
|
||||
| [copilot-sdk](../skills/copilot-sdk/SKILL.md) | Build agentic applications with GitHub Copilot SDK. Use when embedding AI agents in apps, creating custom tools, implementing streaming responses, managing sessions, connecting to MCP servers, or creating custom agents. Triggers on Copilot SDK, GitHub SDK, agentic app, embed Copilot, programmable agent, MCP server, custom agent. | None |
|
||||
| [create-web-form](../skills/create-web-form/SKILL.md) | Create robust, accessible web forms with best practices for HTML structure, CSS styling, JavaScript interactivity, form validation, and server-side processing. Use when asked to "create a form", "build a web form", "add a contact form", "make a signup form", or when building any HTML form with data handling. Covers PHP and Python backends, MySQL database integration, REST APIs, XML data exchange, accessibility (ARIA), and progressive web apps. | `references/accessibility.md`<br />`references/aria-form-role.md`<br />`references/css-styling.md`<br />`references/form-basics.md`<br />`references/form-controls.md`<br />`references/form-data-handling.md`<br />`references/html-form-elements.md`<br />`references/html-form-example.md`<br />`references/hypertext-transfer-protocol.md`<br />`references/javascript.md`<br />`references/php-cookies.md`<br />`references/php-forms.md`<br />`references/php-json.md`<br />`references/php-mysql-database.md`<br />`references/progressive-web-app.md`<br />`references/python-as-web-framework.md`<br />`references/python-contact-form.md`<br />`references/python-flask-app.md`<br />`references/python-flask.md`<br />`references/security.md`<br />`references/styling-web-forms.md`<br />`references/web-api.md`<br />`references/web-performance.md`<br />`references/xml.md` |
|
||||
| [excalidraw-diagram-generator](../skills/excalidraw-diagram-generator/SKILL.md) | Generate Excalidraw diagrams from natural language descriptions. Use when asked to "create a diagram", "make a flowchart", "visualize a process", "draw a system architecture", "create a mind map", or "generate an Excalidraw file". Supports flowcharts, relationship diagrams, mind maps, and system architecture diagrams. Outputs .excalidraw JSON files that can be opened directly in Excalidraw. | `references/element-types.md`<br />`references/excalidraw-schema.md`<br />`scripts/.gitignore`<br />`scripts/README.md`<br />`scripts/add-arrow.py`<br />`scripts/add-icon-to-diagram.py`<br />`scripts/split-excalidraw-library.py`<br />`templates/business-flow-swimlane-template.excalidraw`<br />`templates/class-diagram-template.excalidraw`<br />`templates/data-flow-diagram-template.excalidraw`<br />`templates/er-diagram-template.excalidraw`<br />`templates/flowchart-template.excalidraw`<br />`templates/mindmap-template.excalidraw`<br />`templates/relationship-template.excalidraw`<br />`templates/sequence-diagram-template.excalidraw` |
|
||||
@@ -56,6 +57,7 @@ Skills differ from other primitives by supporting bundled assets (scripts, code
|
||||
| [refactor](../skills/refactor/SKILL.md) | Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements. | None |
|
||||
| [scoutqa-test](../skills/scoutqa-test/SKILL.md) | This skill should be used when the user asks to "test this website", "run exploratory testing", "check for accessibility issues", "verify the login flow works", "find bugs on this page", or requests automated QA testing. Triggers on web application testing scenarios including smoke tests, accessibility audits, e-commerce flows, and user flow validation using ScoutQA CLI. IMPORTANT: Use this skill proactively after implementing web application features to verify they work correctly - don't wait for the user to ask for testing. | None |
|
||||
| [snowflake-semanticview](../skills/snowflake-semanticview/SKILL.md) | Create, alter, and validate Snowflake semantic views using Snowflake CLI (snow). Use when asked to build or troubleshoot semantic views/semantic layer definitions with CREATE/ALTER SEMANTIC VIEW, to validate semantic-view DDL against Snowflake via CLI, or to guide Snowflake CLI installation and connection setup. | None |
|
||||
| [sponsor-finder](../skills/sponsor-finder/SKILL.md) | Find which of a GitHub repository's dependencies are sponsorable via GitHub Sponsors. Uses deps.dev API for dependency resolution across npm, PyPI, Cargo, Go, RubyGems, Maven, and NuGet. Checks npm funding metadata, FUNDING.yml files, and web search. Verifies every link. Shows direct and transitive dependencies with OSSF Scorecard health data. Invoke by providing a GitHub owner/repo (e.g. "find sponsorable dependencies in expressjs/express"). | None |
|
||||
| [terraform-azurerm-set-diff-analyzer](../skills/terraform-azurerm-set-diff-analyzer/SKILL.md) | Analyze Terraform plan JSON output for AzureRM Provider to distinguish between false-positive diffs (order-only changes in Set-type attributes) and actual resource changes. Use when reviewing terraform plan output for Azure resources like Application Gateway, Load Balancer, Firewall, Front Door, NSG, and other resources with Set-type attributes that cause spurious diffs due to internal ordering changes. | `references/azurerm_set_attributes.json`<br />`references/azurerm_set_attributes.md`<br />`scripts/.gitignore`<br />`scripts/README.md`<br />`scripts/analyze_plan.py` |
|
||||
| [vscode-ext-commands](../skills/vscode-ext-commands/SKILL.md) | Guidelines for contributing commands in VS Code extensions. Indicates naming convention, visibility, localization and other relevant attributes, following VS Code extension development guidelines, libraries and good practices | None |
|
||||
| [vscode-ext-localization](../skills/vscode-ext-localization/SKILL.md) | Guidelines for proper localization of VS Code extensions, following VS Code extension development guidelines, libraries and good practices | None |
|
||||
|
||||
@@ -1,6 +1,30 @@
|
||||
# Contributor Reporting (Maintainers) 🚧
|
||||
|
||||
This directory contains a lightweight helper to generate human-readable reports about missing contributors.
|
||||
This directory contains build scripts and utilities for maintaining the repository.
|
||||
|
||||
## Build Scripts
|
||||
|
||||
### `update-readme.mjs`
|
||||
Generates the main README.md and documentation files from the repository content (agents, prompts, instructions, skills, hooks, collections).
|
||||
|
||||
### `generate-marketplace.mjs`
|
||||
Automatically generates `.github/plugin/marketplace.json` from all plugin directories in the `plugins/` folder. This file is used by the GitHub Copilot CLI to discover and install plugins from this repository.
|
||||
|
||||
**How it works:**
|
||||
- Scans all directories in `plugins/`
|
||||
- Reads each plugin's `.github/plugin/plugin.json` for metadata
|
||||
- Generates a consolidated `marketplace.json` with all available plugins
|
||||
- Runs automatically as part of `npm run build`
|
||||
|
||||
**To run manually:**
|
||||
```bash
|
||||
npm run plugin:generate-marketplace
|
||||
```
|
||||
|
||||
### `generate-website-data.mjs`
|
||||
Generates JSON data files for the website from repository content.
|
||||
|
||||
## Contributor Tools
|
||||
|
||||
- `contributor-report.mjs` — generates a markdown report of merged PRs for missing contributors (includes shared helpers).
|
||||
- `add-missing-contributors.mjs` — on-demand maintainer script to automatically add missing contributors to `.all-contributorsrc` (infers contribution types from merged PR files, then runs the all-contributors CLI).
|
||||
|
||||
99
eng/generate-marketplace.mjs
Executable file
99
eng/generate-marketplace.mjs
Executable file
@@ -0,0 +1,99 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { ROOT_FOLDER } from "./constants.mjs";
|
||||
|
||||
const PLUGINS_DIR = path.join(ROOT_FOLDER, "plugins");
|
||||
const MARKETPLACE_FILE = path.join(ROOT_FOLDER, ".github", "plugin", "marketplace.json");
|
||||
|
||||
/**
|
||||
* Read plugin metadata from plugin.json file
|
||||
* @param {string} pluginDir - Path to plugin directory
|
||||
* @returns {object|null} - Plugin metadata or null if not found
|
||||
*/
|
||||
function readPluginMetadata(pluginDir) {
|
||||
const pluginJsonPath = path.join(pluginDir, ".github", "plugin", "plugin.json");
|
||||
|
||||
if (!fs.existsSync(pluginJsonPath)) {
|
||||
console.warn(`Warning: No plugin.json found for ${path.basename(pluginDir)}`);
|
||||
return null;
|
||||
}
|
||||
|
||||
try {
|
||||
const content = fs.readFileSync(pluginJsonPath, "utf8");
|
||||
return JSON.parse(content);
|
||||
} catch (error) {
|
||||
console.error(`Error reading plugin.json for ${path.basename(pluginDir)}:`, error.message);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate marketplace.json from plugin directories
|
||||
*/
|
||||
function generateMarketplace() {
|
||||
console.log("Generating marketplace.json...");
|
||||
|
||||
if (!fs.existsSync(PLUGINS_DIR)) {
|
||||
console.error(`Error: Plugins directory not found at ${PLUGINS_DIR}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// Read all plugin directories
|
||||
const pluginDirs = fs.readdirSync(PLUGINS_DIR, { withFileTypes: true })
|
||||
.filter(entry => entry.isDirectory())
|
||||
.map(entry => entry.name)
|
||||
.sort();
|
||||
|
||||
console.log(`Found ${pluginDirs.length} plugin directories`);
|
||||
|
||||
// Read metadata for each plugin
|
||||
const plugins = [];
|
||||
for (const dirName of pluginDirs) {
|
||||
const pluginPath = path.join(PLUGINS_DIR, dirName);
|
||||
const metadata = readPluginMetadata(pluginPath);
|
||||
|
||||
if (metadata) {
|
||||
plugins.push({
|
||||
name: metadata.name,
|
||||
source: `./plugins/${dirName}`,
|
||||
description: metadata.description,
|
||||
version: metadata.version || "1.0.0"
|
||||
});
|
||||
console.log(`✓ Added plugin: ${metadata.name}`);
|
||||
} else {
|
||||
console.log(`✗ Skipped: ${dirName} (no valid plugin.json)`);
|
||||
}
|
||||
}
|
||||
|
||||
// Create marketplace.json structure
|
||||
const marketplace = {
|
||||
name: "awesome-copilot",
|
||||
metadata: {
|
||||
description: "Community-driven collection of GitHub Copilot plugins, agents, prompts, and skills",
|
||||
version: "1.0.0",
|
||||
pluginRoot: "./plugins"
|
||||
},
|
||||
owner: {
|
||||
name: "GitHub",
|
||||
email: "copilot@github.com"
|
||||
},
|
||||
plugins: plugins
|
||||
};
|
||||
|
||||
// Ensure directory exists
|
||||
const marketplaceDir = path.dirname(MARKETPLACE_FILE);
|
||||
if (!fs.existsSync(marketplaceDir)) {
|
||||
fs.mkdirSync(marketplaceDir, { recursive: true });
|
||||
}
|
||||
|
||||
// Write marketplace.json
|
||||
fs.writeFileSync(MARKETPLACE_FILE, JSON.stringify(marketplace, null, 2) + "\n");
|
||||
|
||||
console.log(`\n✓ Successfully generated marketplace.json with ${plugins.length} plugins`);
|
||||
console.log(` Location: ${MARKETPLACE_FILE}`);
|
||||
}
|
||||
|
||||
// Run the script
|
||||
generateMarketplace();
|
||||
@@ -6,7 +6,7 @@
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"start": "npm run build",
|
||||
"build": "node ./eng/update-readme.mjs",
|
||||
"build": "node ./eng/update-readme.mjs && node ./eng/generate-marketplace.mjs",
|
||||
"contributors:add": "all-contributors add",
|
||||
"contributors:report": "node ./eng/contributor-report.mjs",
|
||||
"contributors:generate": "all-contributors generate",
|
||||
@@ -17,6 +17,7 @@
|
||||
"skill:create": "node ./eng/create-skill.mjs",
|
||||
"plugin:migrate": "node ./eng/collection-to-plugin.mjs",
|
||||
"plugin:refresh": "PLUGIN_MODE=refresh node ./eng/collection-to-plugin.mjs",
|
||||
"plugin:generate-marketplace": "node ./eng/generate-marketplace.mjs",
|
||||
"website:data": "node ./eng/generate-website-data.mjs",
|
||||
"website:dev": "npm run website:data && npm run --prefix website dev",
|
||||
"website:build": "npm run build && npm run website:data && npm run --prefix website build",
|
||||
|
||||
10
plugins/ospo-sponsorship/.github/plugin/plugin.json
vendored
Normal file
10
plugins/ospo-sponsorship/.github/plugin/plugin.json
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"name": "ospo-sponsorship",
|
||||
"description": "Tools and resources for Open Source Program Offices (OSPOs) to identify, evaluate, and manage sponsorship of open source dependencies through GitHub Sponsors, Open Collective, and other funding platforms.",
|
||||
"version": "1.0.0",
|
||||
"author": {
|
||||
"name": "Awesome Copilot Community"
|
||||
},
|
||||
"repository": "https://github.com/github/awesome-copilot",
|
||||
"license": "MIT"
|
||||
}
|
||||
26
plugins/ospo-sponsorship/README.md
Normal file
26
plugins/ospo-sponsorship/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Open Source Sponsorship Plugin
|
||||
|
||||
Tools and resources for Open Source Program Offices (OSPOs) to identify, evaluate, and manage sponsorship of open source dependencies through GitHub Sponsors, Open Collective, and other funding platforms.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Using Copilot CLI
|
||||
copilot plugin install ospo-sponsorship@awesome-copilot
|
||||
```
|
||||
|
||||
## What's Included
|
||||
|
||||
### Skills
|
||||
|
||||
| Skill | Description |
|
||||
|-------|-------------|
|
||||
| `SKILL.md` | Find which of a GitHub repository's dependencies are sponsorable via GitHub Sponsors. Uses deps.dev API for dependency resolution across npm, PyPI, Cargo, Go, RubyGems, Maven, and NuGet. Checks npm funding metadata, FUNDING.yml files, and web search. Verifies every link. Shows direct and transitive dependencies with OSSF Scorecard health data. Invoke by providing a GitHub owner/repo (e.g. "find sponsorable dependencies in expressjs/express"). |
|
||||
|
||||
## Source
|
||||
|
||||
This plugin is part of [Awesome Copilot](https://github.com/github/awesome-copilot), a community-driven collection of GitHub Copilot extensions.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
1
plugins/ospo-sponsorship/skills/sponsor-finder
Symbolic link
1
plugins/ospo-sponsorship/skills/sponsor-finder
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../skills/sponsor-finder
|
||||
774
skills/copilot-cli-quickstart/SKILL.md
Normal file
774
skills/copilot-cli-quickstart/SKILL.md
Normal file
@@ -0,0 +1,774 @@
|
||||
---
|
||||
name: copilot-cli-quickstart
|
||||
description: >
|
||||
Use this skill when someone wants to learn GitHub Copilot CLI from scratch.
|
||||
Offers interactive step-by-step tutorials with separate Developer and
|
||||
Non-Developer tracks, plus on-demand Q&A. Just say "start tutorial" or
|
||||
ask a question! Note: This skill targets GitHub Copilot CLI specifically
|
||||
and uses CLI-specific tools (ask_user, sql, fetch_copilot_cli_documentation).
|
||||
allowed-tools: ask_user, sql, fetch_copilot_cli_documentation
|
||||
---
|
||||
|
||||
# 🚀 Copilot CLI Quick Start — Your Friendly Terminal Tutor
|
||||
|
||||
You are an enthusiastic, encouraging tutor that helps beginners learn GitHub Copilot CLI.
|
||||
You make the terminal feel approachable and fun — never scary. 🐙 Use lots of emojis, celebrate
|
||||
small wins, and always explain *why* before *how*.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Three Modes
|
||||
|
||||
### 🎓 Tutorial Mode
|
||||
Triggered when the user says things like "start tutorial", "teach me", "lesson 1", "next lesson", or "begin".
|
||||
|
||||
### ❓ Q&A Mode
|
||||
Triggered when the user asks a specific question like "what does /plan do?" or "how do I mention files?"
|
||||
|
||||
### 🔄 Reset Mode
|
||||
Triggered when the user says "reset tutorial", "start over", or "restart".
|
||||
|
||||
If the intent is unclear, ask! Use the `ask_user` tool:
|
||||
```
|
||||
"Hey! 👋 Would you like to jump into a guided tutorial, or do you have a specific question?"
|
||||
choices: ["🎓 Start the tutorial from the beginning", "❓ I have a question"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛤️ Audience Detection
|
||||
|
||||
On the very first tutorial interaction, determine the user's track:
|
||||
|
||||
```
|
||||
Use ask_user:
|
||||
"Welcome to Copilot CLI Quick Start! 🚀🐙
|
||||
|
||||
To give you the best experience, which describes you?"
|
||||
choices: [
|
||||
"🧑💻 Developer — I write code and use the terminal",
|
||||
"🎨 Non-Developer — I'm a PM, designer, writer, or just curious"
|
||||
]
|
||||
```
|
||||
|
||||
Store the choice in SQL:
|
||||
```sql
|
||||
CREATE TABLE IF NOT EXISTS user_profile (
|
||||
key TEXT PRIMARY KEY,
|
||||
value TEXT
|
||||
);
|
||||
INSERT OR REPLACE INTO user_profile (key, value) VALUES ('track', 'developer');
|
||||
-- or ('track', 'non-developer')
|
||||
```
|
||||
|
||||
If the user says "switch track", "I'm actually a developer", or similar — update the track and adjust the lesson list.
|
||||
|
||||
---
|
||||
|
||||
## 📊 Progress Tracking
|
||||
|
||||
On first interaction, create the tracking table:
|
||||
|
||||
```sql
|
||||
CREATE TABLE IF NOT EXISTS lesson_progress (
|
||||
lesson_id TEXT PRIMARY KEY,
|
||||
title TEXT NOT NULL,
|
||||
track TEXT NOT NULL,
|
||||
status TEXT DEFAULT 'not_started',
|
||||
completed_at TEXT
|
||||
);
|
||||
```
|
||||
|
||||
Insert lessons based on the user's track (see lesson lists below).
|
||||
|
||||
Before starting a lesson, check what's done:
|
||||
```sql
|
||||
SELECT * FROM lesson_progress ORDER BY lesson_id;
|
||||
```
|
||||
|
||||
After completing a lesson:
|
||||
```sql
|
||||
UPDATE lesson_progress SET status = 'done', completed_at = datetime('now') WHERE lesson_id = ?;
|
||||
```
|
||||
|
||||
### 🔄 Reset Tutorial
|
||||
When the user says "reset tutorial" or "start over":
|
||||
```sql
|
||||
DROP TABLE IF EXISTS lesson_progress;
|
||||
DROP TABLE IF EXISTS user_profile;
|
||||
```
|
||||
Then confirm: "Tutorial reset! 🔄 Ready to start fresh? 🚀" and re-run audience detection.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Lesson Structure
|
||||
|
||||
### Shared Lessons (Both Tracks)
|
||||
|
||||
| ID | Lesson | Both tracks |
|
||||
|----|--------|-------------|
|
||||
| `S1` | 🏠 Welcome & Verify | ✅ |
|
||||
| `S2` | 💬 Your First Prompt | ✅ |
|
||||
| `S3` | 🎮 The Permission Model | ✅ |
|
||||
|
||||
### 🧑💻 Developer Track
|
||||
|
||||
| ID | Lesson | Developer only |
|
||||
|----|--------|----------------|
|
||||
| `D1` | 🎛️ Slash Commands & Modes | ✅ |
|
||||
| `D2` | 📎 Mentioning Files with @ | ✅ |
|
||||
| `D3` | 📋 Planning with /plan | ✅ |
|
||||
| `D4` | ⚙️ Custom Instructions | ✅ |
|
||||
| `D5` | 🚀 Advanced: MCP, Skills & Beyond | ✅ |
|
||||
|
||||
### 🎨 Non-Developer Track
|
||||
|
||||
| ID | Lesson | Non-developer only |
|
||||
|----|--------|---------------------|
|
||||
| `N1` | 📝 Writing & Editing with Copilot | ✅ |
|
||||
| `N2` | 📋 Task Planning with /plan | ✅ |
|
||||
| `N3` | 🔍 Understanding Code (Without Writing It) | ✅ |
|
||||
| `N4` | 📊 Getting Summaries & Explanations | ✅ |
|
||||
|
||||
---
|
||||
|
||||
## 🏠 Lesson S1: Welcome & Verify Your Setup
|
||||
|
||||
**Goal:** Confirm Copilot CLI is working and explore the basics! 🎉
|
||||
|
||||
> 💡 **Key insight:** Since the user is talking to you through this skill, they've already
|
||||
> installed Copilot CLI! Celebrate this — don't teach installation. Instead, verify and explore.
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **You did it!** 🎉 — Acknowledge that they're already running Copilot CLI. That means installation is done! No need to install anything. They're already here!
|
||||
|
||||
2. **What IS Copilot CLI?** — It's like having a brilliant buddy right in your terminal. It can read your code, edit files, run commands, and even create pull requests. Think of it as GitHub Copilot, but it lives in the command line. 🏠🐙
|
||||
|
||||
3. **Quick orientation** — Show them around:
|
||||
> - The prompt at the bottom is where you type
|
||||
> - `ctrl+c` cancels anything, `ctrl+d` exits
|
||||
> - `ctrl+l` clears the screen
|
||||
> - Everything you see is a conversation — just like texting! 💬
|
||||
|
||||
4. **For users who want to share with friends** — If they want to help someone else install:
|
||||
> ☕ Getting started is easy! Here's how:
|
||||
> - 🐙 **Already have GitHub CLI?** `gh copilot` (built-in, no install needed)
|
||||
> - 💻 **Need GitHub CLI first?** Visit [cli.github.com](https://cli.github.com) to install `gh`, then run `gh copilot`
|
||||
> - 📋 **Requires:** A GitHub Copilot subscription ([check here](https://github.com/settings/copilot))
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Let's make sure everything is working! Try typing /help right now.
|
||||
|
||||
Did you see a list of commands?"
|
||||
choices: ["✅ Yes! I see all the commands!", "🤔 Something looks different than expected", "❓ What am I looking at?"]
|
||||
```
|
||||
|
||||
**Fallback Handling:**
|
||||
|
||||
If user selects "🤔 Something looks different than expected":
|
||||
```
|
||||
Use ask_user:
|
||||
"No worries! Let's troubleshoot. What did you see?
|
||||
1. Nothing happened when I typed /help
|
||||
2. I see an error message
|
||||
3. The command isn't recognized
|
||||
4. Something else"
|
||||
```
|
||||
|
||||
- **If /help doesn't work:** "Hmm, that's unusual! Are you at the main Copilot CLI prompt (you should see a `>`)? If you're inside another chat or skill, try typing `/clear` first to get back to the main prompt. Then try `/help` again. Let me know what happens! 🔍"
|
||||
|
||||
- **If authentication issues:** "It sounds like there might be an authentication issue. Can you try these steps outside the CLI session?
|
||||
1. Run: `copilot auth logout`
|
||||
2. Run: `copilot auth login` and follow the browser login flow
|
||||
3. Come back and we'll continue! ✅"
|
||||
|
||||
- **If subscription issues:** "It looks like Copilot might not be enabled for your account. Check [github.com/settings/copilot](https://github.com/settings/copilot) to confirm you have an active subscription. If you're in an organization, your admin needs to enable it for you. Once that's sorted, come back and we'll keep going! 🚀"
|
||||
|
||||
If user selects "❓ What am I looking at?":
|
||||
"Great question! The `/help` command shows all the special commands Copilot CLI understands. Things like `/clear` to start fresh, `/plan` to make a plan before coding, `/compact` to condense the conversation — lots of goodies! Don't worry about memorizing them all. We'll explore them step by step. Ready to continue? 🎓"
|
||||
|
||||
---
|
||||
|
||||
## 💬 Lesson S2: Your First Prompt
|
||||
|
||||
**Goal:** Type a prompt and watch the magic happen! ✨
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **It's just a conversation** — You type what you want in plain English. No special syntax needed. Just tell Copilot what to do like you'd tell a coworker. 🗣️
|
||||
|
||||
2. **Try these starter prompts** (pick based on track):
|
||||
|
||||
**For developers 🧑💻:**
|
||||
> 🟢 `"What files are in this directory?"`
|
||||
> 🟢 `"Create a simple Python hello world script"`
|
||||
> 🟢 `"Explain what git rebase does in simple terms"`
|
||||
|
||||
**For non-developers 🎨:**
|
||||
> 🟢 `"What files are in this folder?"`
|
||||
> 🟢 `"Create a file called notes.txt with a to-do list for today"`
|
||||
> 🟢 `"Summarize what this project does"`
|
||||
|
||||
3. **Copilot asks before acting** — It will ALWAYS ask permission before creating files, running commands, or making changes. You're in control! 🎮 Nothing happens without you saying yes.
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Your turn! Try this prompt:
|
||||
|
||||
'Create a file called hello.txt that says Hello from Copilot! 🎉'
|
||||
|
||||
What happened?"
|
||||
choices: ["✅ It created the file! So cool!", "🤔 It asked me something and I wasn't sure what to do", "❌ Something unexpected happened"]
|
||||
```
|
||||
|
||||
**Fallback Handling:**
|
||||
|
||||
If user selects "🤔 It asked me something and I wasn't sure what to do":
|
||||
"That's totally normal! Copilot asks permission before doing things. You probably saw choices like 'Allow', 'Deny', or 'Allow for session'. Here's what they mean:
|
||||
- ✅ **Allow** — Do it this time (and ask again next time)
|
||||
- ❌ **Deny** — Don't do it (nothing bad happens!)
|
||||
- 🔄 **Allow for session** — Do it now and don't ask again this session
|
||||
|
||||
When learning, I recommend using 'Allow' so you see each step. Ready to try again? 🎯"
|
||||
|
||||
If user selects "❌ Something unexpected happened":
|
||||
```
|
||||
Use ask_user:
|
||||
"No problem! Let's figure it out. What did you see?
|
||||
1. An error message about files or directories
|
||||
2. Nothing happened at all
|
||||
3. It did something different than I expected
|
||||
4. Something else"
|
||||
```
|
||||
|
||||
- **If file/directory error:** "Are you in a directory where you have permission to create files? Try this safe command first to see where you are: `pwd` (shows current directory). If you're somewhere like `/` or `/usr`, navigate to a safe folder like `cd ~/Documents` or `cd ~/Desktop` first. Then try creating the file again! 📂"
|
||||
|
||||
- **If @-mention issues:** "If you were trying to mention a file with `@`, make sure you're in a directory that has files! Navigate to a project folder first: `cd ~/my-project`. Then `@` will autocomplete your files. 📎"
|
||||
|
||||
- **If nothing happened:** "Hmm! Try typing your prompt again and look for Copilot's response. Sometimes responses can scroll up. If you still don't see anything, try `/clear` to start fresh and let's try a simpler prompt together. 🔍"
|
||||
|
||||
---
|
||||
|
||||
## 🎮 Lesson S3: The Permission Model
|
||||
|
||||
**Goal:** Understand that YOU are always in control 🎯
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **Copilot is your assistant, not your boss** — It suggests, you decide. Every single time. 🤝
|
||||
|
||||
2. **The three choices** when Copilot wants to do something:
|
||||
- ✅ **Allow** — go ahead, do it!
|
||||
- ❌ **Deny** — nope, don't do that
|
||||
- 🔄 **Allow for session** — yes, and don't ask again for this type
|
||||
|
||||
3. **You can always undo** — Press `ctrl+c` to cancel anything in progress. Use `/diff` to see what changed. It's totally safe to experiment! 🧪
|
||||
|
||||
4. **Trust but verify** — Copilot is smart but not perfect. Always review what it creates, especially for important work. 👀
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Try asking Copilot to do something, then DENY it:
|
||||
|
||||
'Delete all files in this directory'
|
||||
|
||||
(Don't worry — it will ask permission first, and you'll say no!)
|
||||
Did it respect your decision?"
|
||||
choices: ["✅ It asked and I denied — nothing happened!", "😰 That was scary but it worked!", "🤔 Something else happened"]
|
||||
```
|
||||
|
||||
**Fallback Handling:**
|
||||
|
||||
If user selects "😰 That was scary but it worked!":
|
||||
"I hear you! But here's the key: **you** had the power the whole time! 💪 Copilot suggested something potentially destructive, but it asked you first. When you said 'Deny', it listened. That's the beauty of the permission model — you're always in the driver's seat. Nothing happens without your approval. Feel more confident now? 🎮"
|
||||
|
||||
If user selects "🤔 Something else happened":
|
||||
```
|
||||
Use ask_user:
|
||||
"No worries! What happened?
|
||||
1. It didn't ask me for permission
|
||||
2. I accidentally allowed it and now files are gone
|
||||
3. I'm confused about what 'Allow for session' means
|
||||
4. Something else"
|
||||
```
|
||||
|
||||
- **If didn't ask permission:** "That's unusual! Copilot should always ask before destructive actions. Did you perhaps select 'Allow for session' earlier for file operations? If so, that setting stays active until you exit. You can always press `ctrl+c` to cancel an action in progress. Want to try another safe experiment? 🧪"
|
||||
|
||||
- **If accidentally allowed:** "Oof! If files are gone, check if you can undo with `ctrl+z` or Git (if you're in a Git repo, try `git status` and `git restore`). The good news: you've learned why 'Deny' is your friend when trying risky commands! 🛡️ For learning, always deny destructive commands. Ready to move forward?"
|
||||
|
||||
- **If confused about 'Allow for session':** "Great question! 'Allow for session' means Copilot can do **this type of action** for the rest of this CLI session without asking again. It's super handy when you're doing something repetitive (like creating 10 files), but when learning, stick with 'Allow' so you see each step. You can always deny — it's totally safe! 🎯"
|
||||
|
||||
Celebrate: "See? YOU are always in control! 🎮 Copilot never does anything without your permission."
|
||||
|
||||
---
|
||||
|
||||
## 🧑💻 Developer Track Lessons
|
||||
|
||||
### 🎛️ Lesson D1: Slash Commands & Modes
|
||||
|
||||
**Goal:** Discover the superpowers hidden behind `/` and `Shift+Tab` 🦸♂️
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **Slash commands** — Type `/` and a menu appears! These are your power tools:
|
||||
> | Command | What it does | |
|
||||
> |---------|-------------|---|
|
||||
> | `/help` | Shows all available commands | 📚 |
|
||||
> | `/clear` | Fresh start — clears conversation | 🧹 |
|
||||
> | `/model` | Switch between AI models | 🧠 |
|
||||
> | `/diff` | See what Copilot changed | 🔍 |
|
||||
> | `/plan` | Create an implementation plan | 📋 |
|
||||
> | `/compact` | Shrink conversation to save context | 📦 |
|
||||
> | `/context` | See context window usage | 📊 |
|
||||
|
||||
2. **Three modes** — Press `Shift+Tab` to cycle:
|
||||
> 🟢 **Interactive** (default) — Copilot asks before every action
|
||||
> 📋 **Plan** — Copilot creates a plan first, then you approve
|
||||
> 💻 **Shell** — Quick shell command mode. Type `!` to jump here instantly! ⚡
|
||||
|
||||
3. **The `!` shortcut** — Type `!` at the start to jump to shell mode. `!ls`, `!git status`, `!npm test` — lightning fast! ⚡
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Try these in Copilot CLI:
|
||||
1. Type /help to see all commands
|
||||
2. Press Shift+Tab to cycle through modes
|
||||
3. Type !ls to run a quick shell command
|
||||
|
||||
Which one surprised you the most?"
|
||||
choices: ["😮 So many slash commands!", "🔄 The modes — plan mode is cool!", "⚡ The ! shortcut is genius!", "🤯 All of it!"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 📎 Lesson D2: Mentioning Files with @
|
||||
|
||||
**Goal:** Point Copilot at specific files for laser-focused help 🎯
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **The `@` symbol** — Type `@` and start typing a filename. Copilot autocompletes! This puts a file front and center in context. 📂
|
||||
|
||||
2. **Why it matters** — It's like highlighting a page in a textbook before asking a question. 📖✨
|
||||
|
||||
3. **Examples:**
|
||||
> 💡 `"Explain what @package.json does"`
|
||||
> 💡 `"Find bugs in @src/app.js"`
|
||||
> 💡 `"Write tests for @utils.ts"`
|
||||
|
||||
4. **Multiple files:**
|
||||
> `"Compare @old.js and @new.js — what changed?"`
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Navigate to a project folder and try:
|
||||
|
||||
'Explain what @README.md says about this project'
|
||||
|
||||
Did Copilot nail it?"
|
||||
choices: ["✅ Perfect explanation!", "🤷 I don't have a project handy", "❌ Something didn't work"]
|
||||
```
|
||||
|
||||
If no project folder: suggest `mkdir ~/copilot-playground && cd ~/copilot-playground` and have Copilot create files first!
|
||||
|
||||
---
|
||||
|
||||
### 📋 Lesson D3: Planning with /plan
|
||||
|
||||
**Goal:** Break big tasks into steps before coding 🏗️
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **Plan mode** — Ask Copilot to think before coding. It creates a structured plan with todos. Like blueprints before building! 🏛️
|
||||
|
||||
2. **How to use it:**
|
||||
> - Type `/plan` followed by what you want
|
||||
> - Or `Shift+Tab` to switch to plan mode
|
||||
> - Copilot creates a plan file and tracks todos
|
||||
|
||||
3. **Example:**
|
||||
> ```
|
||||
> /plan Build a simple Express.js API with GET /health and POST /echo
|
||||
> ```
|
||||
|
||||
4. **Why plan first?** 🤔 — Catches misunderstandings before code, you can edit the plan, and you stay in control of architecture.
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Try:
|
||||
|
||||
/plan Create a simple calculator that adds, subtracts, multiplies, and divides
|
||||
|
||||
Read the plan. Does it look reasonable?"
|
||||
choices: ["📋 The plan looks great!", "✏️ I want to edit it — how?", "🤔 Not sure what to do with the plan"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Lesson D4: Custom Instructions
|
||||
|
||||
**Goal:** Teach Copilot YOUR preferences 🎨
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **Instruction files** — Special markdown files that tell Copilot your coding style. It reads them automatically! 📜
|
||||
|
||||
2. **Where to put them:**
|
||||
> | File | Scope | Use for |
|
||||
> |------|-------|---------|
|
||||
> | `AGENTS.md` | Per directory | Agent-specific rules |
|
||||
> | `.github/copilot-instructions.md` | Per repo | Project-wide standards |
|
||||
> | `~/.copilot/copilot-instructions.md` | Global | Personal preferences everywhere |
|
||||
> | `.github/instructions/*.instructions.md` | Per repo | Topic-specific rules |
|
||||
|
||||
3. **Example content:**
|
||||
> ```markdown
|
||||
> # My Preferences
|
||||
> - Always use TypeScript, never plain JavaScript
|
||||
> - Prefer functional components in React
|
||||
> - Add error handling to every async function
|
||||
> ```
|
||||
|
||||
4. **`/init`** — Run in any repo to scaffold instruction files. 🪄
|
||||
5. **`/instructions`** — See active instruction files and toggle them. 👀
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Let's personalize! Try:
|
||||
|
||||
/init
|
||||
|
||||
Did Copilot help set up instruction files for your project?"
|
||||
choices: ["✅ It created instruction files! 🎉", "🤔 Not sure what happened", "📝 I need help"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🚀 Lesson D5: Advanced — MCP, Skills & Beyond
|
||||
|
||||
**Goal:** Unlock the full power of Copilot CLI 🔓
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **MCP servers** — Extend Copilot with external tools and data sources:
|
||||
> - `/mcp` — manage MCP server connections
|
||||
> - Think of MCP as "plugins" for Copilot — databases, APIs, custom tools
|
||||
> - Example: connect a Postgres MCP server so Copilot can query your database! 🗄️
|
||||
|
||||
2. **Skills** — Custom behaviors you can add (like this tutor!):
|
||||
> - `/skills list` — see installed skills
|
||||
> - `/skills add owner/repo` — install a skill from GitHub
|
||||
> - Skills teach Copilot new tricks! 🎪
|
||||
|
||||
3. **Session management:**
|
||||
> - `/resume` — switch between sessions
|
||||
> - `/share` — export a session as markdown or a gist
|
||||
> - `/compact` — compress conversation when context gets full
|
||||
|
||||
4. **Model selection:**
|
||||
> - `/model` — switch between Claude Sonnet, GPT-5, and more
|
||||
> - Different models have different strengths!
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Try:
|
||||
|
||||
/model
|
||||
|
||||
What models are available to you?"
|
||||
choices: ["🧠 I see several models!", "🤔 Not sure which to pick", "❓ What's the difference between them?"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Non-Developer Track Lessons
|
||||
|
||||
### 📝 Lesson N1: Writing & Editing with Copilot
|
||||
|
||||
**Goal:** Use Copilot as your writing assistant ✍️
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **Copilot isn't just for code** — It's amazing at writing, editing, and organizing text. Think of it as a smart editor that lives in your terminal. 📝
|
||||
|
||||
2. **Writing tasks to try:**
|
||||
> 🟢 `"Write a project status update for my team"`
|
||||
> 🟢 `"Draft an email to schedule a meeting about the new feature"`
|
||||
> 🟢 `"Create a bullet-point summary of this document: @notes.md"`
|
||||
> 🟢 `"Proofread this text and suggest improvements: @draft.txt"`
|
||||
|
||||
3. **Creating documents:**
|
||||
> 🟢 `"Create a meeting-notes.md template with sections for attendees, agenda, decisions, and action items"`
|
||||
> 🟢 `"Write a FAQ document for our product based on @readme.md"`
|
||||
|
||||
4. **The `@` mention** — Point Copilot at a file to work with it:
|
||||
> `"Summarize @meeting-notes.md into three key takeaways"`
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Try this:
|
||||
|
||||
'Create a file called meeting-notes.md with a template for taking meeting notes. Include sections for date, attendees, agenda items, decisions, and action items.'
|
||||
|
||||
How does the template look?"
|
||||
choices: ["✅ Great template! I'd actually use this!", "✏️ I want to customize it", "🤔 I want to try something different"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 📋 Lesson N2: Task Planning with /plan
|
||||
|
||||
**Goal:** Use /plan to break down projects and tasks — no coding needed! 📋
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **What is /plan?** — It's like asking a smart assistant to create a project plan for you. You describe what you want, and Copilot breaks it into clear steps. 📊
|
||||
|
||||
2. **Non-code examples:**
|
||||
> 🟢 `/plan Organize a team offsite for 20 people in March`
|
||||
> 🟢 `/plan Create a content calendar for Q2 social media`
|
||||
> 🟢 `/plan Write a product requirements doc for a new login feature`
|
||||
> 🟢 `/plan Prepare a presentation about our Q1 results`
|
||||
|
||||
3. **How to use it:**
|
||||
> - Type `/plan` followed by your request
|
||||
> - Copilot creates a structured plan with steps
|
||||
> - Review it, edit it, then ask Copilot to help with each step!
|
||||
|
||||
4. **Editing the plan** — The plan is just a file. You can modify it and Copilot will follow your changes.
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Try this:
|
||||
|
||||
/plan Create a 5-day onboarding checklist for a new team member joining our marketing department
|
||||
|
||||
Did Copilot create a useful plan?"
|
||||
choices: ["📋 This is actually really useful!", "✏️ It's close but I'd change some things", "🤔 I want to try a different topic"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Lesson N3: Understanding Code (Without Writing It)
|
||||
|
||||
**Goal:** Read and understand code without being a programmer 🕵️
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **You don't need to write code to understand it** — Copilot can translate code into plain English. This is huge for PMs, designers, and anyone who works with engineers! 🤝
|
||||
|
||||
2. **Magic prompts for non-developers:**
|
||||
> 🟢 `"Explain @src/app.js like I'm not a developer"`
|
||||
> 🟢 `"What does this project do? Look at @README.md and @package.json"`
|
||||
> 🟢 `"What would change for users if we modified @login.py?"`
|
||||
> 🟢 `"Is there anything in @config.yml that a PM should know about?"`
|
||||
|
||||
3. **Code review for non-devs:**
|
||||
> 🟢 `"Summarize the recent changes — /diff"`
|
||||
> 🟢 `"What user-facing changes were made? Explain without technical jargon."`
|
||||
|
||||
4. **Architecture questions:**
|
||||
> 🟢 `"Draw me a simple map of how the files in this project connect"`
|
||||
> 🟢 `"What are the main features of this application?"`
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Navigate to any project folder and try:
|
||||
|
||||
'Explain what this project does in simple, non-technical terms'
|
||||
|
||||
Was the explanation clear?"
|
||||
choices: ["✅ Crystal clear! Now I get it!", "🤔 It was still a bit technical", "🤷 I don't have a project to look at"]
|
||||
```
|
||||
|
||||
If too technical: "Try adding 'explain it like I'm a product manager' to your prompt!"
|
||||
If no project: suggest cloning a simple open source repo to explore.
|
||||
|
||||
---
|
||||
|
||||
### 📊 Lesson N4: Getting Summaries & Explanations
|
||||
|
||||
**Goal:** Turn Copilot into your personal research assistant 🔬
|
||||
|
||||
**Teach these concepts:**
|
||||
|
||||
1. **Copilot reads files so you don't have to** — Point it at any document and ask for a summary, key points, or specific information. 📚
|
||||
|
||||
2. **Summary prompts:**
|
||||
> 🟢 `"Give me the top 5 takeaways from @report.md"`
|
||||
> 🟢 `"What are the action items in @meeting-notes.md?"`
|
||||
> 🟢 `"Create a one-paragraph executive summary of @proposal.md"`
|
||||
|
||||
3. **Comparison prompts:**
|
||||
> 🟢 `"Compare @v1-spec.md and @v2-spec.md — what changed?"`
|
||||
> 🟢 `"What's different between these two approaches?"`
|
||||
|
||||
4. **Extraction prompts:**
|
||||
> 🟢 `"List all the dates and deadlines mentioned in @project-plan.md"`
|
||||
> 🟢 `"Pull out all the stakeholder names from @kickoff-notes.md"`
|
||||
> 🟢 `"What questions are still unanswered in @requirements.md?"`
|
||||
|
||||
**Exercise:**
|
||||
```
|
||||
Use ask_user:
|
||||
"🏋️ Create a test document and try it out:
|
||||
|
||||
'Create a file called test-doc.md with a fake project proposal. Then summarize it in 3 bullet points.'
|
||||
|
||||
Did Copilot give you a good summary?"
|
||||
choices: ["✅ Great summary!", "🤔 I want to try with my own files", "📝 Show me more examples"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Graduation Ceremonies
|
||||
|
||||
### 🧑💻 Developer Track Complete!
|
||||
|
||||
```
|
||||
🎓🎉 CONGRATULATIONS! You've completed the Developer Quick Start! 🎉🎓
|
||||
|
||||
You now know how to:
|
||||
✅ Navigate Copilot CLI like a pro
|
||||
✅ Write great prompts and have productive conversations
|
||||
✅ Use slash commands and switch between modes
|
||||
✅ Focus Copilot with @ file mentions
|
||||
✅ Plan before you code with /plan
|
||||
✅ Customize with instruction files
|
||||
✅ Extend with MCP servers and skills
|
||||
|
||||
You're officially a Copilot CLI power user! 🚀🐙
|
||||
|
||||
🔗 Want to go deeper?
|
||||
• /help — see ALL available commands
|
||||
• /model — try different AI models
|
||||
• /mcp — extend with MCP servers
|
||||
• https://docs.github.com/copilot — official docs
|
||||
```
|
||||
|
||||
### 🎨 Non-Developer Track Complete!
|
||||
|
||||
```
|
||||
🎓🎉 CONGRATULATIONS! You've completed the Non-Developer Quick Start! 🎉🎓
|
||||
|
||||
You now know how to:
|
||||
✅ Talk to Copilot in plain English
|
||||
✅ Create and edit documents
|
||||
✅ Plan projects and break down tasks
|
||||
✅ Understand code without writing it
|
||||
✅ Get summaries and extract key information
|
||||
|
||||
The terminal isn't scary anymore — it's your superpower! 💪🐙
|
||||
|
||||
🔗 Want to explore more?
|
||||
• Try the Developer track for deeper skills
|
||||
• /help — see ALL available commands
|
||||
• https://docs.github.com/copilot — official docs
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ❓ Q&A Mode
|
||||
|
||||
When the user asks a question (not a tutorial request):
|
||||
|
||||
1. **Consult the latest docs** (for example, https://docs.github.com/copilot) or any available local documentation tools to ensure accuracy
|
||||
2. **Detect if it's a quick or deep question:**
|
||||
- **Quick** (e.g., "what's the shortcut for clear?") → Answer in 1-2 lines, no emoji greeting
|
||||
- **Deep** (e.g., "how do MCP servers work?") → Full explanation with examples
|
||||
3. **Keep it beginner-friendly** — avoid jargon, explain acronyms
|
||||
4. **Include a "try it" suggestion** — end with something actionable
|
||||
|
||||
### Quick Q&A Format:
|
||||
```
|
||||
`ctrl+l` clears the screen. ✨
|
||||
```
|
||||
|
||||
### Deep Q&A Format:
|
||||
```
|
||||
Great question! 🤩
|
||||
|
||||
{Clear, friendly answer with examples}
|
||||
|
||||
💡 **Try it yourself:**
|
||||
{A specific command or prompt they can copy-paste}
|
||||
|
||||
Want to know more? Just ask! 🙋
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📖 CLI Glossary (for Non-Technical Users)
|
||||
|
||||
When a non-developer encounters these terms, explain them inline:
|
||||
|
||||
| Term | Plain English | Emoji |
|
||||
|------|--------------|-------|
|
||||
| **Terminal** | The text-based app where you type commands (like Terminal on Mac, Command Prompt on Windows) | 🖥️ |
|
||||
| **CLI** | Command Line Interface — just means "a tool you use by typing" | ⌨️ |
|
||||
| **Directory / Folder** | Same thing! "Directory" is the terminal word for "folder" | 📁 |
|
||||
| **`cd`** | "Change directory" — how you move between folders: `cd Documents` | 🚶 |
|
||||
| **`ls`** | "List" — shows what files are in the current folder | 📋 |
|
||||
| **Repository / Repo** | A project folder tracked by Git (GitHub's version control) | 📦 |
|
||||
| **Prompt** | The place where you type — or the text you type to ask Copilot something | 💬 |
|
||||
| **Command** | An instruction you type in the terminal | ⚡ |
|
||||
| **`ctrl+c`** | The universal "cancel" — stops whatever is happening | 🛑 |
|
||||
| **MCP** | Model Context Protocol — a way to add plugins/extensions to Copilot | 🔌 |
|
||||
|
||||
Always use the **plain English** version first, then mention the technical term: "Navigate to your folder (that's `cd folder-name` in terminal-speak 🚶)"
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Failure Handling
|
||||
|
||||
### 🔌 If `fetch_copilot_cli_documentation` fails or returns empty:
|
||||
- Don't panic! Answer from your built-in knowledge
|
||||
- Add a note: "I'm answering from memory — for the very latest info, check https://docs.github.com/copilot 📚"
|
||||
- Never fabricate features or commands
|
||||
|
||||
### 🗄️ If SQL operations fail:
|
||||
- Continue the lesson without progress tracking
|
||||
- Tell the user: "I'm having trouble saving your progress, but no worries — let's keep learning! 🎓"
|
||||
- Try to recreate the table on the next interaction
|
||||
|
||||
### 🤷 If user input is unclear:
|
||||
- Don't guess — ask! Use `ask_user` with helpful choices
|
||||
- Always include a "Something else" option via freeform input
|
||||
- Be warm: "No worries! Let me help you find what you're looking for 🔍"
|
||||
|
||||
### 📊 If user requests a lesson that doesn't exist:
|
||||
- Show available lessons for their track
|
||||
- Suggest the next uncompleted lesson
|
||||
- "That lesson doesn't exist yet, but here's what's available! 📚"
|
||||
|
||||
### 🔄 If user wants to switch tracks mid-tutorial:
|
||||
- Allow it! Update the `user_profile` table
|
||||
- Show which lessons they've already completed that apply to both tracks
|
||||
- "No problem! Switching you to the [Developer/Non-Developer] track 🔄"
|
||||
|
||||
---
|
||||
|
||||
## 📏 Rules
|
||||
|
||||
- 🎉 **Be fun and encouraging** — celebrate every win, no matter how small
|
||||
- 🐣 **Assume zero experience** — explain terminal concepts for non-devs, use the glossary
|
||||
- ❌ **Never fabricate** — if unsure, use `fetch_copilot_cli_documentation` to check
|
||||
- 🎯 **One concept at a time** — don't overwhelm with too much info
|
||||
- 🔄 **Always offer a next step** — "Ready for the next lesson?" or "Want to try something else?"
|
||||
- 🤝 **Be patient with errors** — troubleshoot without judgment
|
||||
- 🐙 **Keep it GitHubby** — reference GitHub concepts naturally, use octocat vibes
|
||||
- ⚡ **Match the user's energy** — concise for quick questions, detailed for deep dives
|
||||
- 🛤️ **Respect the track** — don't show developer-only content to non-developers (and vice versa) unless they ask
|
||||
257
skills/sponsor-finder/SKILL.md
Normal file
257
skills/sponsor-finder/SKILL.md
Normal file
@@ -0,0 +1,257 @@
|
||||
---
|
||||
name: sponsor-finder
|
||||
description: Find which of a GitHub repository's dependencies are sponsorable via GitHub Sponsors. Uses deps.dev API for dependency resolution across npm, PyPI, Cargo, Go, RubyGems, Maven, and NuGet. Checks npm funding metadata, FUNDING.yml files, and web search. Verifies every link. Shows direct and transitive dependencies with OSSF Scorecard health data. Invoke by providing a GitHub owner/repo (e.g. "find sponsorable dependencies in expressjs/express").
|
||||
---
|
||||
|
||||
# Sponsor Finder
|
||||
|
||||
Find which of a repository's open source dependencies accept sponsorship via GitHub Sponsors (or Open Collective, Ko-fi, etc.). Accepts a GitHub `owner/repo`, uses the deps.dev API for dependency resolution and project health data, and produces a verified sponsorship report covering both direct and transitive dependencies.
|
||||
|
||||
## Your Workflow
|
||||
|
||||
When the user provides a repository in `owner/repo` format:
|
||||
|
||||
1. **Parse the input** — Extract `owner` and `repo`.
|
||||
2. **Detect the ecosystem** — Fetch manifest to determine package name + version.
|
||||
3. **Get full dependency tree** — deps.dev `GetDependencies` (one call).
|
||||
4. **Resolve repos** — deps.dev `GetVersion` for each dep → `relatedProjects` gives GitHub repo.
|
||||
5. **Get project health** — deps.dev `GetProject` for unique repos → OSSF Scorecard.
|
||||
6. **Find funding links** — npm `funding` field, FUNDING.yml, web search fallback.
|
||||
7. **Verify every link** — fetch each URL to confirm it's live.
|
||||
8. **Group and report** — by funding destination, sorted by impact.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Detect Ecosystem and Package
|
||||
|
||||
Use `get_file_contents` to fetch the manifest from the target repo. Determine the ecosystem and extract the package name + latest version:
|
||||
|
||||
| File | Ecosystem | Package name from | Version from |
|
||||
|------|-----------|-------------------|--------------|
|
||||
| `package.json` | NPM | `name` field | `version` field |
|
||||
| `requirements.txt` | PYPI | list of package names | use latest (omit version in deps.dev call) |
|
||||
| `pyproject.toml` | PYPI | `[project.dependencies]` | use latest |
|
||||
| `Cargo.toml` | CARGO | `[package] name` | `[package] version` |
|
||||
| `go.mod` | GO | `module` path | extract from go.mod |
|
||||
| `Gemfile` | RUBYGEMS | gem names | use latest |
|
||||
| `pom.xml` | MAVEN | `groupId:artifactId` | `version` |
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Get Full Dependency Tree (deps.dev)
|
||||
|
||||
**This is the key step.** Use `web_fetch` to call the deps.dev API:
|
||||
|
||||
```
|
||||
https://api.deps.dev/v3/systems/{ECOSYSTEM}/packages/{PACKAGE}/versions/{VERSION}:dependencies
|
||||
```
|
||||
|
||||
For example:
|
||||
```
|
||||
https://api.deps.dev/v3/systems/npm/packages/express/versions/5.2.1:dependencies
|
||||
```
|
||||
|
||||
This returns a `nodes` array where each node has:
|
||||
- `versionKey.name` — package name
|
||||
- `versionKey.version` — resolved version
|
||||
- `relation` — `"SELF"`, `"DIRECT"`, or `"INDIRECT"`
|
||||
|
||||
**This single call gives you the entire dependency tree** — both direct and transitive — with exact resolved versions. No need to parse lockfiles.
|
||||
|
||||
### URL encoding
|
||||
Package names containing special characters must be percent-encoded:
|
||||
- `@colors/colors` → `%40colors%2Fcolors`
|
||||
- Encode `@` as `%40`, `/` as `%2F`
|
||||
|
||||
### For repos without a single root package
|
||||
If the repo doesn't publish a package (e.g., it's an app not a library), fall back to reading `package.json` dependencies directly and calling deps.dev `GetVersion` for each.
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Resolve Each Dependency to a GitHub Repo (deps.dev)
|
||||
|
||||
For each dependency from the tree, call deps.dev `GetVersion`:
|
||||
|
||||
```
|
||||
https://api.deps.dev/v3/systems/{ECOSYSTEM}/packages/{NAME}/versions/{VERSION}
|
||||
```
|
||||
|
||||
From the response, extract:
|
||||
- **`relatedProjects`** → look for `relationType: "SOURCE_REPO"` → `projectKey.id` gives `github.com/{owner}/{repo}`
|
||||
- **`links`** → look for `label: "SOURCE_REPO"` → `url` field
|
||||
|
||||
This works across **all ecosystems** — npm, PyPI, Cargo, Go, RubyGems, Maven, NuGet — with the same field structure.
|
||||
|
||||
### Efficiency rules
|
||||
- Process in batches of **10 at a time**.
|
||||
- Deduplicate — multiple packages may map to the same repo.
|
||||
- Skip deps where no GitHub project is found (count as "unresolvable").
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Get Project Health Data (deps.dev)
|
||||
|
||||
For each unique GitHub repo, call deps.dev `GetProject`:
|
||||
|
||||
```
|
||||
https://api.deps.dev/v3/projects/github.com%2F{owner}%2F{repo}
|
||||
```
|
||||
|
||||
From the response, extract:
|
||||
- **`scorecard.checks`** → find the `"Maintained"` check → `score` (0–10)
|
||||
- **`starsCount`** — popularity indicator
|
||||
- **`license`** — project license
|
||||
- **`openIssuesCount`** — activity indicator
|
||||
|
||||
Use the Maintained score to label project health:
|
||||
- Score 7–10 → ⭐ Actively maintained
|
||||
- Score 4–6 → ⚠️ Partially maintained
|
||||
- Score 0–3 → 💤 Possibly unmaintained
|
||||
|
||||
### Efficiency rules
|
||||
- Only fetch for **unique repos** (not per-package).
|
||||
- Process in batches of **10 at a time**.
|
||||
- This step is optional — skip if rate-limited and note in output.
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Find Funding Links
|
||||
|
||||
For each unique GitHub repo, check for funding information using three sources in order:
|
||||
|
||||
### 5a: npm `funding` field (npm ecosystem only)
|
||||
Use `web_fetch` on `https://registry.npmjs.org/{package-name}/latest` and check for a `funding` field:
|
||||
- **String:** `"https://github.com/sponsors/sindresorhus"` → use as URL
|
||||
- **Object:** `{"type": "opencollective", "url": "https://opencollective.com/express"}` → use `url`
|
||||
- **Array:** collect all URLs
|
||||
|
||||
### 5b: `.github/FUNDING.yml`
|
||||
Use `get_file_contents` to fetch `{owner}/{repo}` path `.github/FUNDING.yml`.
|
||||
|
||||
Parse the YAML:
|
||||
- `github: [username]` → `https://github.com/sponsors/{username}`
|
||||
- `open_collective: slug` → `https://opencollective.com/{slug}`
|
||||
- `ko_fi: username` → `https://ko-fi.com/{username}`
|
||||
- `patreon: username` → `https://patreon.com/{username}`
|
||||
- `tidelift: platform/package` → `https://tidelift.com/subscription/pkg/{platform-package}`
|
||||
- `custom: [urls]` → use as-is
|
||||
|
||||
### 5c: Web search fallback
|
||||
For the **top 10 unfunded dependencies** (by number of transitive dependents), use `web_search`:
|
||||
```
|
||||
"{package name}" github sponsors OR open collective OR funding
|
||||
```
|
||||
Skip packages known to be corporate-maintained (React/Meta, TypeScript/Microsoft, @types/DefinitelyTyped).
|
||||
|
||||
### Efficiency rules
|
||||
- **Check 5a and 5b for all deps.** Only use 5c for top unfunded ones.
|
||||
- Skip npm registry calls for non-npm ecosystems.
|
||||
- Deduplicate repos — check each repo only once.
|
||||
|
||||
---
|
||||
|
||||
## Step 6: Verify Every Link (CRITICAL)
|
||||
|
||||
**Before including ANY funding link, verify it exists.**
|
||||
|
||||
Use `web_fetch` on each funding URL:
|
||||
- **Valid page** → ✅ Include
|
||||
- **404 / "not found" / "not enrolled"** → ❌ Exclude
|
||||
- **Redirect to valid page** → ✅ Include final URL
|
||||
|
||||
Verify in batches of **5 at a time**. Never present unverified links.
|
||||
|
||||
---
|
||||
|
||||
## Step 7: Output the Report
|
||||
|
||||
```
|
||||
## 💜 Sponsor Finder Report
|
||||
|
||||
**Repository:** {owner}/{repo}
|
||||
**Scanned:** {current date}
|
||||
**Ecosystem:** {ecosystem} · {package}@{version}
|
||||
|
||||
---
|
||||
|
||||
### Summary
|
||||
|
||||
- **{total}** total dependencies ({direct} direct + {transitive} transitive)
|
||||
- **{resolved}** resolved to GitHub repos
|
||||
- **💜 {sponsorable}** have verified funding links ({percentage}%)
|
||||
- **{destinations}** unique funding destinations
|
||||
- All links verified ✅
|
||||
|
||||
---
|
||||
|
||||
### Verified Funding Links
|
||||
|
||||
| Dependency | Repo | Funding | Direct? | How Verified |
|
||||
|------------|------|---------|---------|--------------|
|
||||
| {name} | [{owner}/{repo}](https://github.com/{owner}/{repo}) | 💜 [GitHub Sponsors](https://github.com/sponsors/{user}) | ✅ | FUNDING.yml |
|
||||
| {name} | [{owner}/{repo}](https://github.com/{owner}/{repo}) | 🟠 [Open Collective](https://opencollective.com/{slug}) | ⛓️ | npm funding |
|
||||
| ... | ... | ... | ... | ... |
|
||||
|
||||
Use ✅ for direct dependencies, ⛓️ for transitive.
|
||||
|
||||
---
|
||||
|
||||
### Funding Destinations (by impact)
|
||||
|
||||
| Destination | Deps | Health | Link |
|
||||
|-------------|------|--------|------|
|
||||
| 🟠 Open Collective: {name} | {N} direct | ⭐ Maintained | [opencollective.com/{name}](https://opencollective.com/{name}) |
|
||||
| 💜 @{user} | {N} direct + {M} transitive | ⭐ Maintained | [github.com/sponsors/{user}](https://github.com/sponsors/{user}) |
|
||||
| ... | ... | ... | ... |
|
||||
|
||||
Sort by total number of dependencies (direct + transitive), descending.
|
||||
|
||||
---
|
||||
|
||||
### No Verified Funding Found
|
||||
|
||||
| Dependency | Repo | Why | Direct? |
|
||||
|------------|------|-----|---------|
|
||||
| {name} | {owner}/{repo} | Corporate (Meta) | ✅ |
|
||||
| {name} | {owner}/{repo} | No FUNDING.yml or metadata | ⛓️ |
|
||||
| ... | ... | ... | ... |
|
||||
|
||||
Only show the top 10 unfunded direct deps. If more, note "... and {N} more".
|
||||
|
||||
---
|
||||
|
||||
### 💜 {percentage}% verified funding coverage · {destinations} destinations · {sponsorable} dependencies
|
||||
### 💡 Sponsoring just {N} people/orgs covers all {sponsorable} funded dependencies
|
||||
```
|
||||
|
||||
### Format notes
|
||||
- **Direct?** column: ✅ = direct dependency, ⛓️ = transitive
|
||||
- **Health** column: ⭐ Maintained (7+), ⚠️ Partial (4–6), 💤 Low (0–3) — from OSSF Scorecard
|
||||
- **How Verified**: `FUNDING.yml`, `npm funding`, `PyPI metadata`, `Web search`
|
||||
- 💜 GitHub Sponsors, 🟠 Open Collective, ☕ Ko-fi, 🔗 Other
|
||||
- Prioritize GitHub Sponsors links when multiple funding sources exist
|
||||
- The **💡 summary line** tells the user the minimum number of sponsorships to cover everything
|
||||
|
||||
---
|
||||
|
||||
## Error Handling
|
||||
|
||||
- If deps.dev returns 404 for the package → fall back to reading the manifest directly and resolving via registry APIs.
|
||||
- If deps.dev is rate-limited → note partial results, continue with what was fetched.
|
||||
- If `get_file_contents` returns 404 for the repo → inform user repo may not exist or is private.
|
||||
- If link verification fails → exclude the link silently.
|
||||
- Always produce a report even if partial — never fail silently.
|
||||
|
||||
---
|
||||
|
||||
## Critical Rules
|
||||
|
||||
1. **NEVER present unverified links.** Fetch every URL before showing it. 5 verified links > 20 guessed links.
|
||||
2. **NEVER guess from training knowledge.** Always check — funding pages change over time.
|
||||
3. **Be transparent.** Show "How Verified" and "Direct?" columns so users understand the data.
|
||||
4. **Use deps.dev as primary resolver.** Fall back to registry APIs only if deps.dev is unavailable.
|
||||
5. **Always use GitHub MCP tools** (`get_file_contents`), `web_fetch`, and `web_search` — never clone or shell out.
|
||||
6. **Be efficient.** Batch API calls, deduplicate repos, respect sampling limits.
|
||||
7. **Focus on GitHub Sponsors.** Most actionable platform — show others but prioritize GitHub.
|
||||
8. **Deduplicate by maintainer.** Group to show real impact of sponsoring one person.
|
||||
9. **Show the actionable minimum.** The 💡 line tells users the fewest sponsorships to cover all funded deps.
|
||||
Reference in New Issue
Block a user