Adding copilot-instructions (#308)

* Experimenting using copilot-instructions.md Feature info: https://docs.github.com/en/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot * Apply suggestions from code review Co-authored-by: David Pine <[email protected]> --------- Co-authored-by: David Pine <[email protected]>
CommunityToolkit · Dec 5, 2024 · ac58cc1 · ac58cc1
1 parent a6c8845
commit ac58cc1
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -0,0 +1,26 @@
+## Coding Style
+
+-   Use spaces for indentation with four-spaces per level, unless it is a csproj file, then use two-spaces per level.
+-   For integrations use the following namespace rules:
+    -   If the integration is a hosting integration (starts with CommunityToolkit.Aspire.Hosting), extension methods should be placed in `Aspire.Hosting`.
+    -   If the integration is a client integration (starts with CommunityToolkit.Aspire), extension methods should be placed in `Microsoft.Extensions.Hosting`.
+    -   Use file-scoped namespaces.
+-   All public members require doc comments.
+-   Prefer type declarations over `var` when the type isn't obvious.
+
+## Sample hosting integration
+
+```csharp
+namespace Aspire.Hosting;
+
+public static class SomeProgramExtensions
+{
+    public static IResourceBuilder<SomeProgramResource> AddSomeProgram(
+        this IDistributedApplicationBuilder builder,
+        [ResourceName] string name)
+    {
+        var resource = new SomeProgramResource(name);
+        return builder.AddResource(resource);
+    }
+}
+```