Have copilot handle formatting better #51114
Conversation
Updated guidelines for committing changes and testing. dotnet format doesn't allow for formatting a single file. If copilot tries to format, it'll try the file, then the solution, and then the project resulting in lots of formatting. This will enable us to fix formatting but not mess up the diffs.
|
This PR is targeting |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the GitHub Copilot instructions to improve the code formatting workflow. The change addresses an issue where dotnet format can cause excessive formatting changes across multiple files when trying to format a single file.
- Added guidance to commit changes before formatting to separate logical changes from formatting changes
- Added instruction to update
.git-blame-ignore-revsfile to prevent formatting commits from affecting git blame history
| - When generating code, run `dotnet format` to ensure uniform formatting. | ||
| - Prefer using file-based namespaces for new code. | ||
| - Do not allow unused `using` directives to be committed. | ||
| - commit your changes, and then format them. |
There was a problem hiding this comment.
Capitalized the first word of the sentence for consistency with other guidelines.
| - commit your changes, and then format them. | |
| - Commit your changes, and then format them. |
Copilot uses AI. Check for mistakes.
| - Prefer using file-based namespaces for new code. | ||
| - Do not allow unused `using` directives to be committed. | ||
| - commit your changes, and then format them. | ||
| - add the format commit SHA to the .git-blame-ignore-revs file so that the commit doesn't dirty git blame in the future |
There was a problem hiding this comment.
Capitalized the first word of the sentence for consistency with other guidelines.
| - add the format commit SHA to the .git-blame-ignore-revs file so that the commit doesn't dirty git blame in the future | |
| - Add the format commit SHA to the .git-blame-ignore-revs file so that the commit doesn't dirty git blame in the future |
Copilot uses AI. Check for mistakes.
|
It'll be interesting to see if it will create the git-blame-ignore-refs file in the first place! |
Updated guidelines for committing changes and testing. dotnet format doesn't allow for formatting a single file. If copilot tries to format, it'll try the file, then the solution, and then the project resulting in lots of formatting. This will enable us to fix formatting but not mess up the diffs.