Skip to content

Commit 29e7f39

Browse files
committed
Add GitHub Copilot config, limiting it to managed code
Crucially, having it self-identify on every change, and leave comments. I'll look into other agents later; there's no standard for how to configure them like there is for IDEs, but on the bright side the config is all natural language so a symlink to this file would probably work.
1 parent a630b72 commit 29e7f39

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.github/copilot-instructions.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Project Overview
2+
3+
This is a retro game emulator project, though emulation is mostly handled by libraries, while this repo is focused on the frontend.
4+
5+
## Folder Structure
6+
7+
- `/ExternalProjects`: Contains the source code for some vendored C# libraries.
8+
- `/src`: Contains the source code for the libraries and the frontend.
9+
10+
Only change C# source files (`*.cs`) and project files (`*.csproj`, `*.props`).
11+
12+
## Libraries and Frameworks
13+
14+
- .NET Framework 4.8 for the frontend.
15+
- .NET Standard 2.0 for the libraries, though some newer features are available thanks to polyfills.
16+
17+
## Coding Standards
18+
19+
- Follow the code style conventions given in the root EditorConfig file.
20+
- Leave a comment beside each block of code you touch with your name/version and an explanation of how the old code was broken.
21+
22+
## UI guidelines
23+
24+
- Use American English spellings in strings.
25+
- Avoid changing the GUI if possible. The GUI encompasses instances of the `Form` and `Control` classes from Windows Forms, which usually have a partial class definition in a file named `*.Designer.cs`.

0 commit comments

Comments
 (0)