Skip to content

docs(contributing): add bootstrap troubleshooting guide#11442

Open
okwn wants to merge 4 commits into
warpdotdev:masterfrom
okwn:contrib/warp/bootstrap-docs
Open

docs(contributing): add bootstrap troubleshooting guide#11442
okwn wants to merge 4 commits into
warpdotdev:masterfrom
okwn:contrib/warp/bootstrap-docs

Conversation

@okwn
Copy link
Copy Markdown

@okwn okwn commented May 20, 2026

Summary

Adds a Bootstrap Troubleshooting section to CONTRIBUTING.md with guidance for common failures:

  • macOS: missing Xcode CLI tools, Homebrew issues
  • Linux: missing build deps, Rust version mismatch
  • Windows: Visual Studio requirements, WSL2

Also adds a fallback guide for when bootstrap fails completely.

Why this matters

Bootstrap failures are a common blocker for new contributors. Clear, searchable troubleshooting steps in CONTRIBUTING.md reduce repeated GitHub issues and help contributors self-serve.

Changes

  • Add Bootstrap Troubleshooting section to CONTRIBUTING.md
  • Covers macOS, Linux, Windows, and network/timeout issues
  • Includes a When Bootstrap Fails fallback subsection

Validation

Read the CONTRIBUTING.md bootstrap section and verify the commands make sense for each platform.

Risk/Compatibility

Documentation only. No code changes.

@cla-bot
Copy link
Copy Markdown

cla-bot Bot commented May 20, 2026

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @okwn on file. In order for us to review and merge your code, each contributor must visit https://cla.warp.dev to read and agree to our CLA. Once you have done so, please comment @cla-bot check to trigger another check.

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented May 20, 2026

@okwn

This PR is not linked to an issue that is marked with ready-to-implement.

Issue-state enforcement details:

  • Associated same-repo issues checked: none

  • Required readiness label: ready-to-implement

To continue, link this PR to a same-repo issue such as Closes #123 in the PR description, and make sure that issue has ready-to-implement.

Powered by Oz

@github-actions github-actions Bot added the external-contributor Indicates that a PR has been opened by someone outside the Warp team. label May 20, 2026
Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@okwn

This PR is not linked to an issue that is marked with ready-to-implement.

Issue-state enforcement details:

  • Associated same-repo issues checked: none

  • Required readiness label: ready-to-implement

To continue, link this PR to a same-repo issue such as Closes #123 in the PR description, and make sure that issue has ready-to-implement.

Powered by Oz

Adds Bootstrap Troubleshooting with platform-specific guidance for
macOS, Linux, Windows (WSL2), and network issues.

Closes warpdotdev#11301
@cla-bot cla-bot Bot added the cla-signed label May 20, 2026
Closes warpdotdev#11301 (Windows bootstrap missing libclang and protoc; cargo build fails)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed external-contributor Indicates that a PR has been opened by someone outside the Warp team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant