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: CONTRIBUTING.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,10 @@ For big feature it's advised to raise an issue to discuss it first.
6
6
## TLDR
7
7
8
8
* Install the .NET SDKs
9
-
* To quickly get up and running, you can just run `dotnet build`
10
-
* To run a full build and test locally before pushing, run `./build.sh` or `./buld.ps1`
9
+
* Install PowerShell
10
+
* Restore workloads with `dotnet workload restore` (needs `sudo` on a Mac)
11
+
* To quickly get up and running, you can just run `dotnet build Sentry.sln`
12
+
* To run a full build in Release mode and test, before pushing, run `./build.sh` or `./buld.cmd`
11
13
12
14
## Dependencies
13
15
@@ -29,9 +31,9 @@ For big feature it's advised to raise an issue to discuss it first.
29
31
To build any of `Sentry.Maui`, `Sentry.Maui.Tests`, or `Sentry.Samples.Maui`, you'll need to have .NET SDK 6.0.400 or greater installed, and have installed the MAUI workloads installed, either through Visual Studio setup, or by running `dotnet workload restore` (or `dotnet workload install maui`) from the Sentry source code root directory.
30
32
You may also need other platform dependencies. See https://docs.microsoft.com/dotnet/maui/ for details. Basically, if you can build and run the "MyMauiApp" example you should also be able to build and run the Sentry MAUI sample app.
31
33
32
-
### Targeting Android, iOS and macCatalyst
34
+
### Targeting Android, iOS and Mac Catalyst
33
35
34
-
Although the files in `/src/Sentry/Platforms/` are part of the `Sentry` project, they are [conditionally targeted](https://github.com/getsentry/sentry-dotnet/blob/b1bfe1efc04eb4c911a85f1cf4cd2e5a176d7c8a/src/Sentry/Sentry.csproj#L19-L21) when the platform is Android, iOS or macCatalyst. We build for Android on all platforms, but currently compile iOS and macCatalyst_only when building on a Mac_.
36
+
Although the files in `/src/Sentry/Platforms/` are part of the `Sentry` project, they are [conditionally targeted](https://github.com/getsentry/sentry-dotnet/blob/b1bfe1efc04eb4c911a85f1cf4cd2e5a176d7c8a/src/Sentry/Sentry.csproj#L19-L21) when the platform is Android, iOS or Mac Catalyst. We build for Android on all platforms, but currently compile iOS and Mac Catalyst_only when building on a Mac_.
35
37
36
38
```xml
37
39
<!-- Platform-specific props included here -->
@@ -49,7 +51,7 @@ This repository uses [Verify](https://github.com/VerifyTests/Verify) to store th
49
51
When a change involves modifying the public API area (by for example adding a public method),
50
52
that change will need to be approved, otherwise the CI process will fail.
51
53
52
-
To do that, run the build locally (i.e: `./build.sh` or `pwsh .\build.ps1`)
54
+
To do that, run the build locally (i.e: `./build.sh` or `build.cmd`)
53
55
and commit the `verify` files that were changed.
54
56
55
57
@@ -61,7 +63,7 @@ Apple Silicon processors (such as the "M1") are arm64 processosr. While .NET 6 a
61
63
- Always install the x64 release of .NET Core 3.1 (it is not avaialable for arm64).
62
64
- If prompted, you will need to allow Apple's [Rosetta](https://support.apple.com/HT211861) to be installed. If you have previously done this for another app, you won't be prompted again.
63
65
64
-
If you are only running `dotnet test` on the command line, you don't need to do anything else.
66
+
If you are only running `dotnet test Sentry.sln` on the command line, you don't need to do anything else.
65
67
66
68
If you are using JetBrains Rider as your IDE, you should install the arm64 version of Rider. Within Rider, the .NET SDK used for build and tests is selected under `Preferences` -> `Build, Execution, Deployment` -> `Toolset and Build`.
0 commit comments