docs: add Prerequisites section and fix copilot -i flag#15
Conversation
Add a Prerequisites section to README.md listing required/optional external tools (Git, GitHub Copilot CLI, Claude Code) with install links so new users don't hit undocumented dependency errors. Add the missing -i flag to all gh copilot commands in README.md and CONTRIBUTING.md to fix 'Invalid command format' errors. Add a note in CONTRIBUTING.md pointing back to the README prerequisites. Fixes #9 Fixes #10 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds missing prerequisite/tooling guidance and corrects gh copilot documentation so the Quick Start and contributing workflow work as written.
Changes:
- Add a Prerequisites section to
README.mdwith install links for Git and supported LLM CLI tools. - Fix
gh copilotcommands by adding the required-iflag for interactive mode. - Add a note in
CONTRIBUTING.mdpointing readers to the README prerequisites.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Documents prerequisite tools + fixes gh copilot invocation to use interactive mode. |
| CONTRIBUTING.md | Cross-references prerequisites and fixes gh copilot invocation to use interactive mode. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates PromptKit’s documentation to (1) explicitly document external tooling prerequisites and (2) fix gh copilot command examples to use interactive mode.
Changes:
- Add a new Prerequisites section to
README.mdwith install links for required/optional CLI tools. - Add a cross-reference note in
CONTRIBUTING.mdpointing contributors to the README prerequisites. - Update documented
gh copilotcommands to include-ifor interactive sessions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a Prerequisites section and updates the Quick Start Copilot command to gh copilot -i. |
| CONTRIBUTING.md | Adds a note linking to prerequisites and updates the Copilot workflow command to gh copilot -i. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR improves the repository’s onboarding documentation by explicitly documenting required external tools and correcting gh copilot usage so the Quick Start and contributing workflow run as written.
Changes:
- Add a Prerequisites section to
README.mdwith install links for Git and supported LLM CLIs, plus a pointer to the manual flow. - Update documented
gh copilotinvocations to include-ifor interactive mode. - Add a note in
CONTRIBUTING.mdlinking back to the README prerequisites.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds prerequisites + fixes Quick Start gh copilot command to use interactive mode. |
| CONTRIBUTING.md | Adds prerequisites cross-reference + fixes gh copilot command to use interactive mode. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
This PR addresses two documentation issues:
Prerequisites section (fixes #9)
Adds a Prerequisites section to README.md (above Quick Start) listing each required/optional external tool with install links:
Also adds a cross-reference note in CONTRIBUTING.md pointing readers to the README prerequisites.
Fix copilot -i flag (fixes #10)
Adds the missing -i flag to all
copilotcommands so they start an interactive session instead of producing an Invalid command format error.Fixes #9
Fixes #10