-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Create copilot-instructions.md #62005
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| ## General | ||
|
|
||
| * Make only high confidence suggestions when reviewing code changes. | ||
| * Always use the latest version C#, currently C# 13 features. | ||
| * Never change global.json unless explicitly asked to. | ||
|
|
||
| ## Formatting | ||
|
|
||
| * Apply code-formatting style defined in `.editorconfig`. | ||
| * Prefer file-scoped namespace declarations and single-line using directives. | ||
| * Insert a newline before the opening curly brace of any code block (e.g., after `if`, `for`, `while`, `foreach`, `using`, `try`, etc.). | ||
| * Ensure that the final return statement of a method is on its own line. | ||
| * Use pattern matching and switch expressions wherever possible. | ||
| * Use `nameof` instead of string literals when referring to member names. | ||
| * Ensure that XML doc comments are created for any public APIs. When applicable, include <example> and <code> documentation in the comments. | ||
|
|
||
| ### Nullable Reference Types | ||
|
|
||
| * Declare variables non-nullable, and check for `null` at entry points. | ||
| * Always use `is null` or `is not null` instead of `== null` or `!= null`. | ||
| * Trust the C# null annotations and don't add null checks when the type system says a value cannot be null. | ||
|
|
||
| ### Testing | ||
|
|
||
| * We use xUnit SDK v3 for tests. | ||
| * Do not emit "Act", "Arrange" or "Assert" comments. | ||
| * Use Moq for mocking in tests. | ||
| * Copy existing style in nearby files for test method names and capitalization. | ||
|
|
||
| ## Running tests | ||
|
|
||
| * To build and run tests in the repo, use the `build.sh` script that is located in each subdirectory within the `src` folder. For example, to run the build with tests in the `src/Http` directory, run `./src/Http/build.sh -test`. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
14?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know we don't have a concept of a preview for C# versions but I figured keeping it to versions of the language that have already been publicly shipped with SDK support would be safer and give it a reference to language features that are less likely to change through iterations?