Skip to content

Conversation

@rmoreirao
Copy link

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Copilot AI review requested due to automatic review settings November 18, 2025 14:29
@welcome
Copy link

welcome bot commented Nov 18, 2025

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 18, 2025
@github-actions
Copy link
Contributor

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 links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
copilot/tutorials/customization-library/prompt-files/your-first-prompt-file.md fpt
ghec
fpt
ghec

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

Copilot finished reviewing on behalf of rmoreirao November 18, 2025 14:31
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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'
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant