Skip to content

Conversation

@daisukedd
Copy link

The mode attribute used in older OpenCode examples has been deprecated and replaced by agent.
Using mode causes parsing errors in current versions of OpenCode, while agent works as expected.
This PR updates the README generator prompt to remove the deprecated mode key and align the documentation with the updated OpenCode schema.

Before

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

After

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

This improves accuracy, prevents configuration errors for users, and reflects the current agent configuration model described in the OpenCode documentation.

Fix formatting in README generator prompt.
Copilot AI review requested due to automatic review settings November 30, 2025 14:56
@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/create-readme.md fpt
ghec
fpt
ghec

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

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 30, 2025
Copilot finished reviewing on behalf of daisukedd November 30, 2025 14:58
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 deprecated prompt file configuration syntax by replacing mode: 'agent' with agent: 'agent' in the README generator prompt example. The deprecated mode attribute causes parsing errors in current versions of OpenCode, and this change aligns the documentation with the current schema.

Key changes:

  • Removed deprecated mode: 'agent' line from the YAML frontmatter in the README generator prompt example
  • Retained agent: 'agent' as the correct configuration attribute

💡 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 30, 2025

Choose a reason for hiding this comment

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

While this change correctly updates the deprecated mode: 'agent' to agent: 'agent', the same deprecated pattern exists in 5 other prompt file examples that should also be updated for consistency:

  • content/copilot/tutorials/customization-library/prompt-files/document-api.md (line 26)
  • content/copilot/tutorials/customization-library/prompt-files/generate-unit-tests.md (line 26)
  • content/copilot/tutorials/customization-library/prompt-files/onboarding-plan.md (line 24)
  • content/copilot/tutorials/customization-library/prompt-files/review-code.md (line 28)
  • content/copilot/tutorials/customization-library/prompt-files/your-first-prompt-file.md (line 35)

Updating all occurrences in the same PR would ensure consistent documentation and prevent users from copying deprecated configurations from other examples.

Copilot uses AI. Check for mistakes.
Copy link
Author

Choose a reason for hiding this comment

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

@copilot open a new pull request to apply changes based on this feedback

@Nithin1044558
Copy link

[email protected]

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.

2 participants