Skip to content

Commit 78241e3

Browse files
committed
Add copilot-instructions.md file
1 parent 801d690 commit 78241e3

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

.github/copilot-instructions.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Copilot instructions for this repository
2+
3+
## High level guidance
4+
5+
* Review the `CONTRIBUTING.md` file for instructions to build and test the software.
6+
* Set the `NBGV_GitEngine` environment variable to `Disabled` before running any `dotnet` or `msbuild` commands.
7+
8+
## Software Design
9+
10+
* Design APIs to be highly testable, and all functionality should be tested.
11+
* Avoid introducing binary breaking changes in public APIs of projects under `src` unless their project files have `IsPackable` set to `false`.
12+
13+
## Testing
14+
15+
* There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Test` suffix.
16+
* Tests should use the Xunit testing framework.
17+
18+
## Coding style
19+
20+
* Honor StyleCop rules and fix any reported build warnings *after* getting tests to pass.
21+
* In C# files, use namespace *statements* instead of namespace *blocks* for all new files.
22+
* Add API doc comments to all new public and internal members.

0 commit comments

Comments
 (0)