Skip to content

docs: streamline copilot setup check prompt Phase 1 #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pidster wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: streamline copilot setup check prompt Phase 1 #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions .github/prompts/copilot-setup-check.prompt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
mode: 'agent'
agent: 'agent'
Copy link

Copilot AI Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent frontmatter field name. Other prompt files in this repository use mode: 'agent' (see write-adr.prompt.md and write-prd.prompt.md), but this change introduces agent: 'agent'. This creates an inconsistency across prompt files and may break tooling that expects the mode field.

Suggested change
agent: 'agent'
mode: 'agent'

Copilot uses AI. Check for mistakes.
argument-hint: 'none'
name: 'copilot-setup-check'
Comment on lines +3 to +4
Copy link

Copilot AI Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent frontmatter fields. The argument-hint and name fields are not present in other prompt files in this repository (write-adr.prompt.md, write-prd.prompt.md). Adding these fields without documentation creates inconsistency across prompt templates and may confuse users about which fields are required.

Suggested change
argument-hint: 'none'
name: 'copilot-setup-check'

Copilot uses AI. Check for mistakes.
description: 'Evaluate repository Copilot configuration and provide optimization recommendations.'
tools: ['codebase', 'search', 'editFiles', 'usages', 'problems', 'changes']
tools: ['search/codebase', 'search', 'usages', 'problems', 'changes']
Copy link

Copilot AI Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent tool naming format. Other prompt files use formats like 'search/codebase', 'edit/editFiles', 'runCommands/terminalSelection', etc., but this change introduces 'search/codebase' alongside plain 'search'. The first item uses a slash format while others don't, creating naming inconsistency. Additionally, 'codebase' as a standalone tool doesn't appear in other prompts—it's always used with the 'search/' prefix.

Suggested change
tools: ['search/codebase', 'search', 'usages', 'problems', 'changes']
tools: ['search/codebase', 'usages', 'problems', 'changes']

Copilot uses AI. Check for mistakes.
---

<!-- Top-level section: Defines the primary task (evaluate Copilot setup) and sets expectations for comprehensive analysis and actionable recommendations. -->
Expand Down Expand Up @@ -41,16 +43,13 @@ This evaluation will assess:
### Phase 1: Core Files Assessment

1. **For each file type, check existence and quality**
- Verify presence and structure
- Assess clarity of repository context
- Evaluate AI agent guidance completeness
- Check for conflicting instructions warning mechanisms
- Verify effectiveness of XML semantic tags reinforcing critical requirements
- Suggest improvements for clarity and completeness
- Suggest enhancements for maintainability and organization
- Suggest additions for missing best practices
- Suggest removal of redundant or conflicting content
- Suggest reinforcements (e.g. XML, Mermaid) for critical policies
- Presence & structure
- Clarity & context (includes AI agent guidance)
- Conflict detection & warning mechanisms
- Enforcement markers (XML semantic tags)
- Improvement actions (clarity, maintainability, missing best practices)
- Prune redundancies & resolve conflicts
- Reinforcement opportunities (semantic tags, diagrams)

2. **Evaluate .github/copilot-instructions.md**
- Verify comprehensive project methodology coverage
Expand Down