Skip to content

Update copilot-instructions.md #116049

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.

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

Merged
merged 2 commits into from
May 29, 2025
Merged

Update copilot-instructions.md #116049

merged 2 commits into from
May 29, 2025

Conversation

CarnaViire
Copy link
Member

  • Tweaked the opening instructions to ensure clarity of the agent's reported status
  • Used MUST/SHOULD notation from RFCs
  • Linked local files from the repo as opposed to links to these files on GitHub
  • Added TOC and References section
  • Minor clarifications

Tested on https://github.com/dotnet/runtime/actions/runs/15286139353/job/42996647277

Some tweaks to the instructions to ensure clarity of the agent's reported status
@CarnaViire CarnaViire requested review from ericstj and Copilot May 27, 2025 23:45
Copy link
Contributor

@Copilot 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 the copilot-instructions.md file to improve clarity and enforce a stricter standard using MUST/SHOULD notation. Key changes include updated language on code compilation and testing requirements, restructuring of the TOC and references to use local file links, and minor textual clarifications to the instructions.

@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 27, 2025
@CarnaViire CarnaViire added area-Infrastructure and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels May 27, 2025
Copy link
Contributor

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.


You MUST follow all code-formatting and naming conventions defined in [`.editorconfig`](/.editorconfig).

In addition to the rules enforced by `.editorconfig`, you SHOULD:
Copy link
Member

Choose a reason for hiding this comment

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

Could we also add that we prefer for new tests to be added to existing files rather than to new files as long as there's an existing test file that relevant?

Copy link
Member

Choose a reason for hiding this comment

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

We can do this in a follow-up change.

@stephentoub stephentoub merged commit fa05a08 into main May 29, 2025
13 of 15 checks passed
@stephentoub stephentoub deleted the CarnaViire-patch-1 branch May 29, 2025 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants