docs: Add submodule checkout step to CONTRIBUTING TLDR#5355
Merged
jamescrosswell merged 1 commit intoJul 8, 2026
Merged
Conversation
Fresh clones fail to build until submodules are checked out: Sentry compiles modules/Ben.Demystifier sources directly and profiling references modules/perfview, but only sentry-native initializes itself. Even `dotnet workload restore` fails with a missing project file error, so list the step before workload restore. Co-Authored-By: Claude <noreply@anthropic.com>
vladbrincoveanu
force-pushed
the
docs/contributing-submodule-setup
branch
from
b17af1c to
d99cf4e
Compare
vladbrincoveanu
requested review from
Flash0ver and
jamescrosswell
as code owners
jamescrosswell
approved these changes
Jul 8, 2026
jamescrosswell
left a comment
jamescrosswell
left a comment
Collaborator
There was a problem hiding this comment.
Nice - thanks @vladbrincoveanu ❤️
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On a fresh clone without
--recurse-submodules, builds anddotnet workload restorefail with a missing project file error (modules/perfview/src/FastSerialization/FastSerialization.csproj) that gives no hint submodules are the cause.Since the TLDR already spells out the other setup prerequisites explicitly (SDKs, PowerShell, workloads), adding the submodule checkout keeps that checklist complete for newcomers.
#skip-changelog