Skip to content

docs: improve cross-platform contributor onboarding - #462

Draft
kcelestinomaria wants to merge 4 commits into
facebook:mainfrom
kcelestinomaria:agent/cross-platform-contributor-onboarding
Draft

docs: improve cross-platform contributor onboarding#462
kcelestinomaria wants to merge 4 commits into
facebook:mainfrom
kcelestinomaria:agent/cross-platform-contributor-onboarding

Conversation

@kcelestinomaria

Copy link
Copy Markdown

Summary

  • Keep dependency patch and diff files in LF format across platforms.
  • Document the Windows build prerequisites and a PowerShell getdeps.py build command.
  • Replace vague contributor validation guidance with concrete build, test, and formatting commands.
  • Add PowerShell commands for running the Windows echo sample.

Motivation

The repository supports Windows, but the contributor-facing documentation did
not explain the required C++ toolchain or provide Windows-native examples. In
addition, dependency patches can be checked out with Windows line endings,
which can cause git apply to reject an otherwise valid patch.

These changes improve first-time contributor onboarding without changing
mvfst runtime behavior or public APIs.

Validation

  • Verified the contribution branch is based on the latest upstream main.
  • Ran git diff --check against upstream/main.
  • Verified dependency patch files resolve to text eol=lf through Git attributes.
  • Reviewed the documented commands against the repository's supported
    getdeps.py build and test workflow.

No C++ source or runtime behavior was changed.

@meta-cla meta-cla Bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jul 20, 2026
@kcelestinomaria
kcelestinomaria marked this pull request as ready for review July 20, 2026 23:37
@kcelestinomaria
kcelestinomaria marked this pull request as draft July 20, 2026 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Do not delete this pull request or issue due to inactivity.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant