Skip to content

docs: add bun-only warning to contributing guide#7552

Closed
Zhanbingli wants to merge 1 commit into
anomalyco:devfrom
Zhanbingli:docs/refine-contributing-guide
Closed

docs: add bun-only warning to contributing guide#7552
Zhanbingli wants to merge 1 commit into
anomalyco:devfrom
Zhanbingli:docs/refine-contributing-guide

Conversation

@Zhanbingli

Copy link
Copy Markdown

Summary

This PR refines the CONTRIBUTING.md to address common setup hurdles for new contributors.

Changes

  • Explicit Bun Requirement: Added a warning to strictly use Bun (v1.3+) and avoid npm/pnpm to prevent protocol errors (e.g., EUNSUPPORTEDPROTOCOL with catalog:).
  • Monorepo Navigation: Clarified that core CLI development can be done directly within packages/opencode.

Motivation

As a new contributor, I encountered several "dead loops" during the initial setup:
Attempting to use npm led to errors due to the catalog: protocol.
This update aims to flatten the learning curve for others.

Verification

  • Verified the updated instructions manually by re-cloning and following the new guide.
  • Confirmed that bun install works perfectly while npm fails as expected.

@github-actions

Copy link
Copy Markdown
Contributor

The following comment was made by an LLM, it may be inaccurate:

No duplicate PRs found

@github-actions

Copy link
Copy Markdown
Contributor

Closing this pull request because it has had no updates for more than 60 days. If you plan to continue working on it, feel free to reopen or open a new PR.

@github-actions github-actions Bot closed this Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant