Skip to content

docs: add Prerequisites section to README and CONTRIBUTING#13

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-prerequisites-section-to-readme
Draft

docs: add Prerequisites section to README and CONTRIBUTING#13
Copilot wants to merge 2 commits intomainfrom
copilot/add-prerequisites-section-to-readme

Conversation

Copy link
Contributor

Copilot AI commented Mar 18, 2026

External CLI tools (git, gh + Copilot extension, claude) were referenced in Quick Start commands without any install guidance, causing silent failures for new users.

Changes

  • README.md — adds a ## Prerequisites section above ## Quick Start listing Git, GitHub Copilot CLI (with gh extension install command), and Claude Code, each with official install links; includes a fallback pointer to the manual LLM workflow
  • CONTRIBUTING.md — adds a ## Prerequisites stub at the top that links back to the README section, covering the gh copilot command used in the contributing workflow
Original prompt

This section details on the original issue you should resolve

<issue_title>Add a Prerequisites section to README — external tool dependencies are undocumented</issue_title>
<issue_description>## Problem

The Quick Start section in README.md and the workflow in CONTRIBUTING.md reference several external CLI tools without documenting them as prerequisites or providing installation links. A new user following these instructions will hit errors if the tools aren't already installed.

Instances found

Tool File Line Command
Git README.md L29 git clone https://github.com/microsoft/promptkit.git
GitHub CLI (gh) + Copilot extension README.md L34 gh copilot "Read and execute bootstrap.md"
GitHub CLI (gh) + Copilot extension CONTRIBUTING.md L15 gh copilot "Read bootstrap.md and execute the prompt"
Claude Code CLI README.md L78 claude "Read and execute bootstrap.md"

Proposed solution

Add a Prerequisites section to README.md (above Quick Start) listing each optional/required tool with install links:

## Prerequisites

- **Git**[Install Git](https://git-scm.com/)

The sections below require one of the following LLM CLI tools:

- **GitHub Copilot CLI** — Install the [GitHub CLI](https://cli.github.com/), then run `gh extension install github/gh-copilot`
- **Claude Code**[Install Claude Code](https://docs.anthropic.com/en/docs/claude-code)

Not using a CLI tool? See [Using with any LLM (manual)](#using-with-any-llm-manual).

Optionally, add a brief note in CONTRIBUTING.md pointing readers back to the README prerequisites.</issue_description>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Co-authored-by: Alan-Jowett <20480683+Alan-Jowett@users.noreply.github.com>
Copilot AI changed the title [WIP] Add a prerequisites section to README for external tool dependencies docs: add Prerequisites section to README and CONTRIBUTING Mar 18, 2026
Copilot AI requested a review from Alan-Jowett March 18, 2026 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a Prerequisites section to README — external tool dependencies are undocumented

2 participants