You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+66-25Lines changed: 66 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,13 @@
1
-
Important: **Ensure the code compiles and the tests pass.** Use the "Building & Testing in dotnet/runtime" instructions below.
1
+
**Any code you commit SHOULD compile, and new and existing tests related to the change SHOULD pass.**
2
2
3
-
Additionally,
3
+
You MUST make your best effort to ensure your changes satisfy those criteria before committing. If for any reason you were unable to build or test the changes, you MUST report that. You MUST NOT claim success unless all builds and tests pass as described above.
4
+
5
+
You MUST refer to the [Building & Testing in dotnet/runtime](#building--testing-in-dotnetruntime) instructions and use the commands and approaches specified there before attempting your own suggestions.
6
+
7
+
You MUST follow all code-formatting and naming conventions defined in [`.editorconfig`](/.editorconfig).
8
+
9
+
In addition to the rules enforced by `.editorconfig`, you SHOULD:
4
10
5
-
- Follow all code-formatting and naming conventions defined in `./.editorconfig`.
6
11
- Prefer file-scoped namespace declarations and single-line using directives.
7
12
- Ensure that the final return statement of a method is on its own line.
8
13
- Use pattern matching and switch expressions wherever possible.
- Refer to the section [5.2. How To: Build and Test Specific Library](#52-how-to-build-and-test-specific-library) below.
175
+
176
+
- Test a specific library:
177
+
- Refer to the sections [5.1. How To: Identify Affected Libraries](#51-how-to-identify-affected-libraries) and [5.2. How To: Build and Test Specific Library](#52-how-to-build-and-test-specific-library) below.
178
+
179
+
- More info can be found in the dedicated workflow docs:
-[Build libraries for WebAssembly](https://github.com/dotnet/runtime/blob/main/docs/workflow/building/libraries/webassembly-instructions.md)
207
-
-[Testing Libraries on WebAssembly](https://github.com/dotnet/runtime/blob/main/docs/workflow/testing/libraries/testing-wasm.md)
232
+
- More info can be found in the dedicated workflow docs:
233
+
-[Build libraries for WebAssembly](/docs/workflow/building/libraries/webassembly-instructions.md)
234
+
-[Testing Libraries on WebAssembly](/docs/workflow/testing/libraries/testing-wasm.md)
208
235
209
236
---
210
237
@@ -215,7 +242,7 @@ From the repository root:
215
242
-**Shared Framework Missing**
216
243
217
244
- If the build fails with an error "The shared framework must be built before the local targeting pack can be consumed.", build both the runtime (clr or mono) and the libs.
218
-
E.g., from the repo root, run `./build.sh clr+libs -rc release` if working on Libraries on CoreCLR. Refer to the section `1.2. Baseline Setup`.
245
+
E.g., from the repo root, run `./build.sh clr+libs -rc release` if working on Libraries on CoreCLR. To find the applicable command, refer to the section [1.2. Baseline Setup](#12-baseline-setup).
219
246
220
247
-**Testhost Is Missing**
221
248
@@ -225,7 +252,7 @@ From the repository root:
225
252
that means some of the prerequisites were not built.
226
253
227
254
- To resolve, build both the appropriate runtime (clr or mono) and the libs as a single command before running tests.
228
-
E.g., from the repo root, run `./build.sh clr+libs -rc release` before testing Libraries on CoreCLR. Refer to the section `1.2. Baseline Setup`.
255
+
E.g., from the repo root, run `./build.sh clr+libs -rc release` before testing Libraries on CoreCLR. To find the applicable command, refer to the section [1.2. Baseline Setup](#12-baseline-setup).
229
256
230
257
-**Build Timeout**
231
258
@@ -247,3 +274,17 @@ From the repository root:
247
274
- Use `build.cmd` instead of `build.sh` on Windows.
248
275
- Set PATH: `set PATH=%CD%\.dotnet;%PATH%`
249
276
- All other commands are similar unless otherwise noted.
0 commit comments