Update prompt file to use 'agent' key format#41327
Update prompt file to use 'agent' key format#41327rmoreirao wants to merge 1 commit intogithub:mainfrom
Conversation
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
There was a problem hiding this comment.
Pull Request Overview
This PR attempts to update the YAML frontmatter format in a prompt file tutorial from mode: 'agent' to agent: 'agent'. However, this change introduces an inconsistency with all other prompt file examples in the repository.
Key issue:
- This change conflicts with the established pattern used in all other prompt file examples, which consistently use
mode: 'agent'
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```text copy | ||
| --- | ||
| mode: 'agent' | ||
| agent: 'agent' |
There was a problem hiding this comment.
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.
| agent: 'agent' | |
| mode: 'agent' |
Why:
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following: