Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 30, 2025

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.

Description

VS Code reports lint error on prompt files: "The 'mode' attribute has been deprecated. Please rename it to 'agent'." per VS Code Copilot documentation.

Changes:

  • Renamed mode to agent in all 108 prompt files
  • Updated CONTRIBUTING.md example to reflect new attribute name
  • Updated embedded examples in github-copilot-starter.prompt.md and prompt-builder.prompt.md

Before:

---
mode: 'agent'
description: 'Create a README.md file for the project'
---

After:

---
agent: 'agent'
description: 'Create a README.md file for the project'
---

Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • New collection file.
  • Update to existing instruction, prompt, chat mode, or collection.
  • Other (please specify):

Additional Notes

Pre-existing quoting style inconsistencies (agent: 'agent' vs agent: agent) were preserved to maintain minimal diff.


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

Original prompt

This section details on the original issue you should resolve

<issue_title>Getting Lint Error in prompt files</issue_title>
<issue_description>When used in vs code (latest version), getting error:

The 'mode' attribute has been deprecated. Please rename it to 'agent'.

This complies with the documentation:
https://code.visualstudio.com/docs/copilot/customization/prompt-files</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Fix lint error in prompt files by renaming mode to agent Fix deprecated 'mode' attribute in prompt files by renaming to 'agent' Nov 30, 2025
Copilot AI requested a review from aaronpowell November 30, 2025 23:14
Copilot finished work on behalf of aaronpowell November 30, 2025 23:14
@aaronpowell aaronpowell marked this pull request as ready for review November 30, 2025 23:56
Copilot AI review requested due to automatic review settings November 30, 2025 23:56
@aaronpowell aaronpowell merged commit 2f9c96d into main Nov 30, 2025
9 checks passed
@aaronpowell aaronpowell deleted the copilot/fix-lint-error-in-prompt-files branch November 30, 2025 23:56
Copilot finished reviewing on behalf of aaronpowell November 30, 2025 23:57
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 updates all prompt files (108 files) to comply with VS Code Copilot's latest documentation by renaming the deprecated mode attribute to agent in YAML front matter. The change prevents lint errors in VS Code and aligns with the official VS Code Copilot documentation.

Key changes:

  • Renamed modeagent in all 108 .prompt.md files
  • Updated CONTRIBUTING.md example to reflect new attribute name
  • Updated embedded examples in github-copilot-starter.prompt.md and prompt-builder.prompt.md

Reviewed changes

Copilot reviewed 107 out of 107 changed files in this pull request and generated 1 comment.

File Description
prompts/*.prompt.md (108 files) Renamed mode to agent in YAML front matter
CONTRIBUTING.md Updated example prompt format to use agent attribute
prompts/github-copilot-starter.prompt.md Updated embedded example to use agent attribute
prompts/prompt-builder.prompt.md Updated template example to use agent attribute

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

---
description: "[Clear, concise description from requirements]"
mode: "[agent|ask|edit based on task type]"
agent: "[agent|ask|edit based on task type]"
Copy link

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

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

The documentation comment suggests three possible values (agent, ask, edit), but based on VS Code documentation and the repository's actual usage, only agent and ask appear to be valid values for the agent field. The value edit doesn't appear to be used in any prompt files in this repository. Consider verifying if edit is a valid value and update the documentation accordingly, or remove it if it's not applicable.

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Getting Lint Error in prompt files

2 participants