anomalyco/opencode
1
0
Fork 0
mirror of https://github.com/anomalyco/opencode.git synced 2026-07-22 02:05:26 -04:00
Code Issues 5.9k Packages Projects Releases 19 Wiki Activity

[PR #7552] docs: add bun-only warning to contributing guide #12437

New Issue
Open
opened 2026-02-16 18:17:20 -05:00 by yindo · 0 comments
yindo commented 2026-02-16 18:17:20 -05:00
Owner
Copy Link
Copy Source

Original Pull Request: https://github.com/anomalyco/opencode/pull/7552

State: open
Merged: No

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.
**Original Pull Request:** https://github.com/anomalyco/opencode/pull/7552 **State:** open **Merged:** No --- ### 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.
yindo added the pull-request label 2026-02-16 18:17:20 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
acp
bad
bug
discussion
docs
documentation
enhancement
extension
good first issue
growth
help-wanted
mcp
model-problem
needs:compliance
nix
opentui
perf
pull-request
Mirrored from GitHub Pull Request
 tui
web
windows
zen
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#12437
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?