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
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
This document provides guidelines for using GitHub Copilot to contribute to the .NET MAUI Community Toolkit. It includes instructions on setting up your environment, writing code, and following best practices specific to .NET MAUI.
3
3
4
4
## Prerequisites
5
-
1. Install the latest stable (.NET SDK)[https://dotnet.microsoft.com/en-us/download].
5
+
1. Install the latest stable [.NET SDK](https://dotnet.microsoft.com/en-us/download).
6
6
2. Install .NET MAUI workloads (we recommend using Visual Studio installer).
7
7
8
8
## Setting Up GitHub Copilot
9
9
1. Ensure you have GitHub Copilot installed and enabled in Visual Studio.
10
-
2. Familiarize yourself with the basic usage of GitHub Copilot by reviewing the (official documentation)[https://docs.github.com/en/copilot].
10
+
2. Familiarize yourself with the basic usage of GitHub Copilot by reviewing the [official documentation](https://docs.github.com/en/copilot).
11
11
12
12
## Writing Code with GitHub Copilot
13
13
### General Guidelines
@@ -17,15 +17,15 @@ This document provides guidelines for using GitHub Copilot to contribute to the
17
17
### Specific to .NET MAUI
18
18
* Ensure that any UI components or controls are compatible with .NET MAUI.
19
19
* Avoid using Xamarin.Forms-specific code unless there is a direct .NET MAUI equivalent.
20
-
* Follow the project's coding style and best practices as outlined in the (contributing)[https://github.com/CommunityToolkit/Maui/blob/main/CONTRIBUTING.md] document.
20
+
* Follow the project's coding style and best practices as outlined in the [contributing](https://github.com/CommunityToolkit/Maui/blob/main/CONTRIBUTING.md) document.
21
21
22
22
## Best Practices
23
23
* Use **Trace.WriteLine()** for debug logging instead of **Debug.WriteLine()**.
24
24
* Include a **CancellationToken** as a parameter for methods returning **Task** or **ValueTask**.
25
25
* Use **is** for null checking and type checking.
26
26
* Use file-scoped namespaces to reduce code verbosity.
27
27
* Avoid using the **!** null forgiving operator.
28
-
** Follow naming conventions for enums and property names.
28
+
* Follow naming conventions for enums and property names.
29
29
30
30
### Debug Logging
31
31
* Always use `Trace.WriteLine()` instead of `Debug.WriteLine` for debug logging because `Debug.WriteLine` is removed by the compiler in Release builds
By following these guidelines, you can effectively use GitHub Copilot to contribute to the .NET MAUI Community Toolkit. Thank you for your contributions!
147
+
By following these guidelines, you can effectively use GitHub Copilot to contribute to the .NET MAUI Community Toolkit. Thank you for your contributions!
0 commit comments