create-simple-prompt

Scaffold a GitHub Copilot prompt sample directory with README.md and sample.json.

842|287|Updated Apr 25, 2024
One-click install
npx skills add https://github.com/pnp/copilot-prompts --skill create-simple-prompt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-simple-prompt
Source: https://github.com/pnp/copilot-prompts/tree/main/.github/skills/create-simple-prompt
Command: npx skills add https://github.com/pnp/copilot-prompts --skill create-simple-prompt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating new prompt samples for the copilot-prompts repository often involves manual setup and inconsistent folders, README content, and missing metadata, which slows contributions and reduces discoverability.

Core Features & Use Cases

  • Guides the creation of a new prompt sample under samples/prompts/{folder-name}/ with a properly formatted README.md and assets/sample.json
  • Enforces folder naming conventions, required fields (title, prompt text, description, target product, app prefix, author details, prerequisites), and a standardized structure for easy review and gallery integration
  • Produces a ready-to-use skeleton that contributors can customize for GitHub Copilot prompts and related tools

Quick Start

Provide all required details (Prompt title, Prompt text, Description, Target product, App host prefix, Author name, Author GitHub username, and Prerequisites) and I will scaffold the new prompt sample.

Frequently Asked Questions about create-simple-prompt

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a new GitHub Copilot prompt sample directory?

To scaffold a new GitHub Copilot prompt sample, provide the required title, prompt text, description, target product, app host prefix, and author details. This generates a correctly structured directory under samples/prompts with a README.md and assets/sample.json.

What is the required metadata for creating a prompt sample?

The required metadata for creating a prompt sample includes the prompt title, prompt text, description, target product, app host prefix, author name, author GitHub username, and prerequisites. This information ensures consistency and easy gallery integration.

How do I ensure my prompt sample README is formatted correctly for the gallery?

To ensure your prompt sample README is formatted correctly for the gallery, use this scaffolding tool to enforce folder naming conventions and standardize required fields. It produces a ready-to-use skeleton that contributors can easily customize.

Can I use this to create prompt samples for tools other than GitHub Copilot?

You can use the generated skeleton for related tools, but the scaffolding specifically enforces a standardized structure for GitHub Copilot prompts. It creates a ready-to-use directory designed to ensure discoverability within the copilot-prompts repository.

Why does creating a prompt sample manually slow down repository contributions?

Creating a prompt sample manually slows down repository contributions because it involves manual setup and inconsistent folders, README content, and missing metadata. Scaffolding eliminates this by validating required inputs and enforcing a standardized structure.

What files are generated when scaffolding a prompt sample?

When scaffolding a prompt sample, the tool generates a properly formatted README.md and an assets/sample.json file inside a new directory under samples/prompts. These files capture the validated metadata required for consistency and discoverability.