Skip to content

Update prompt file to use 'agent' key format #41327

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −1
Open

Update prompt file to use 'agent' key format #41327

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
2 changes: 1 addition & 1 deletion .../copilot/tutorials/customization-library/prompt-files/your-first-prompt-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Start with this simple prompt file that helps you write clear, well-documented c

```text copy
---
mode: 'agent'
agent: 'agent'
Copy link

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

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

This change introduces an inconsistency with other prompt files in the same directory. All other prompt files (create-readme.md, document-api.md, generate-unit-tests.md, onboarding-plan.md, and review-code.md) use mode: 'agent' in their YAML frontmatter, not agent: 'agent'.

Additionally, the value agent: 'agent' appears semantically redundant. The key should be mode with the value 'agent' to indicate the mode of operation.

Please update this to use mode: 'agent' to maintain consistency with the other prompt file examples.

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

Copilot uses AI. Check for mistakes.
description: 'Generate a clear code explanation with examples'
---

Expand Down
Loading