Skip to content
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

Create copilot-instructions.md #47204

Merged
merged 1 commit into from
Mar 4, 2025
Merged

Create copilot-instructions.md #47204

merged 1 commit into from
Mar 4, 2025

Conversation

Forgind
Copy link
Member

@Forgind Forgind commented Mar 1, 2025

No description provided.

@Copilot Copilot bot review requested due to automatic review settings March 1, 2025 01:22
@dotnet-issue-labeler dotnet-issue-labeler bot added Area-Infrastructure untriaged Request triage from a team member labels Mar 1, 2025

Choose a reason for hiding this comment

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

PR Overview

This PR introduces a new guidance file, copilot-instructions.md, to document best practices for code changes, test updates, and code style considerations.

  • Added a file with guidelines for minimal changes and testing for large updates.
  • Included a note to seek advice from baronfel on output formatting.

Reviewed Changes

File Description
.github/copilot-instructions.md New document outlining instructions for changes.

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Copy link
Member

@dsplaisted dsplaisted left a comment

Choose a reason for hiding this comment

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

Looks good! Have you tried this out with copilot?

Copy link
Member

@edvilme edvilme left a comment

Choose a reason for hiding this comment

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

image
Works fine. Just left a few comments that I think might be useful :)


Large changes should always include test changes.

When considering how output should look, solicit advice from baronfel.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
When considering how output should look, solicit advice from baronfel.
When considering how output should look, solicit advice from baronfel.
When using strings, prefer having them localized in .resx files
Do not modify .xlf files, instead prompt the user to do so by running `/t:UpdateXlf` on MSBuild

@Forgind Forgind merged commit e849a9d into main Mar 4, 2025
41 checks passed
@Forgind Forgind deleted the copilot-instructions branch March 4, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Infrastructure untriaged Request triage from a team member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants