Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Move instructions to CONTRIBUTING.md
  • Loading branch information
jpnurmi committed Sep 29, 2025
commit 59da77de5762620d11d8db8f2a1ad5bccf0a5f18
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,3 +171,26 @@ Once changes to Ben.Demystifier have been merged into the main branch then, the
should be updated from the main branch and the `modules/make-internal.sh` script run again (if necessary). This repo
should reference the most recent commit on the `internal` branch of Ben.Demystifier then (functionally identical to the
main branch - the only difference being the changes to member visibility).

## Local Sentry Cocoa SDK checkout

By default, `Sentry.Bindings.Cocoa` downloads a pre-built Sentry Cocoa SDK from
GitHub Releases. The version is specified in `modules/sentry-cocoa.properties`.

If you want to build an unreleased Sentry Cocoa SDK version from source instead,
replace the pre-built SDK with [getsentry/sentry-cocoa](https://github.com/getsentry/sentry-cocoa/)
by cloning it into the `modules/sentry-cocoa` directory:

```sh
$ rm -rf modules/sentry-cocoa
$ gh repo clone getsentry/sentry-cocoa modules/sentry-cocoa
$ dotnet build ... # uses modules/sentry-cocoa as is
```

To switch back to the pre-built SDK, delete the `modules/sentry-cocoa` directory
and let the next build download the pre-built SDK again:

```sh
$ rm -rf modules/sentry-cocoa
$ dotnet build ... # downloads pre-built Cocoa SDK into modules/sentry-cocoa
```
10 changes: 0 additions & 10 deletions modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,3 @@ To make sure we're not exposing any API from that library externally.
Fork [getsentry/perfview](https://github.com/getsentry/perfview/).
Tool from the .NET team which includes several utilities used for profiling .NET code.
We use that in our `Sentry.Profiling` package.

### sentry-cocoa

By default, `Sentry.Bindings.Cocoa` downloads a pre-built Sentry Cocoa SDK from
GitHub Releases. The version is specified in `sentry-cocoa.properties`.

If you want to build an unreleased Sentry Cocoa SDK version from source instead,
replace the pre-built SDK with [getsentry/sentry-cocoa](https://github.com/getsentry/sentry-cocoa/)
by cloning it into the `modules/sentry-cocoa` directory. To switch back to the
pre-built SDK, delete the `modules/sentry-cocoa` directory.
Loading