Skip to content

Commit 9c2ac27

Browse files
Clarify the process for maintaining Ben.Demystifier (#4010)
1 parent e25f0f7 commit 9c2ac27

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,3 +153,21 @@ In CI, these packages are expected to be present, while locally, scripts will ru
153153
You can run individual tests either via Pester integration (e.g. in VS Code), or from command line: `./integration-test/cli.Tests.ps1`. Consult Pester docs for details on how to write tests.
154154

155155
Because these tests rely on a Sentry server mock (`Invoke-SentryServer`) from <https://github.com/getsentry/github-workflows/tree/main/sentry-cli/integration-test>, you need to check out [getsentry/github-workflows](https://github.com/getsentry/github-workflows) as a sibling directory next to your `getsentry/sentry-dotnet` checkout.
156+
157+
## Maintaining the Ben.Demystifier Submodule
158+
159+
This repo uses a variety of techniques to vendor in third party code without creating external dependencies. One of
160+
those is submodules.
161+
162+
One of those submodules is Ben.Demystifier, which was originally written by Ben Adams. Attempts to contact Ben in recent
163+
years have been unsuccessful so we've started maintaining a permanent fork of the project at:
164+
- https://github.com/getsentry/Ben.Demystifier
165+
166+
Any significant changes to the submodule should be made in a branch and merged into the submodule's `main` branch.
167+
However, many of the members of Ben.Demystifier are public. That makes sense if people are using Ben.Demystifier as a
168+
library, but in this repo we want to keep those members internal.
169+
170+
Once changes to Ben.Demystifier have been merged into the main branch then, the `internal` branch of Ben.Demystifier
171+
should be updated from the main branch and the `modules/make-internal.sh` script run again (if necessary). This repo
172+
should reference the most recent commit on the `internal` branch of Ben.Demystifier then (functionally identical to the
173+
main branch - the only difference being the changes to member visibility).

0 commit comments

Comments
 (0)