Skip to content

docs: clarify Bun requirement for source development#437

Closed
CooperSheroy wants to merge 1 commit into
lidge-jun:devfrom
CooperSheroy:catalina/source-dev-bun-prereq-20260725
Closed

docs: clarify Bun requirement for source development#437
CooperSheroy wants to merge 1 commit into
lidge-jun:devfrom
CooperSheroy:catalina/source-dev-bun-prereq-20260725

Conversation

@CooperSheroy

@CooperSheroy CooperSheroy commented Jul 25, 2026

Copy link
Copy Markdown

Summary

  • Clarify that source development requires a local bun CLI on PATH
  • Distinguish contributor commands from the published npm package's bundled Bun runtime
  • Add the note to the root contributor entry point, README development section, and hosted contributing docs source

Validation

  • git diff --check
  • Not run: Bun-based project commands, because this cron host currently has node/npm but no bun binary on PATH.

Summary by CodeRabbit

  • Documentation
    • Clarified that source development requires the Bun CLI to be installed and available on the system PATH.
    • Explained the distinction between the locally installed Bun used for development commands and the bundled runtime included with the published package.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 25, 2026
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4e577f55-d8d8-47c5-a08c-9b130c3b5043

📥 Commits

Reviewing files that changed from the base of the PR and between 6f4cd1d and 86e963c.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • README.md
  • docs-site/src/content/docs/contributing.md

📝 Walkthrough

Walkthrough

Development documentation now states that contributors need the bun CLI on their PATH, while published ocx commands use the package’s bundled Bun runtime.

Changes

Contributor Bun prerequisites

Layer / File(s) Summary
Document local Bun requirements
CONTRIBUTING.md, README.md, docs-site/src/content/docs/contributing.md
Adds consistent guidance that source-development commands use a locally installed bun CLI, distinct from the runtime bundled with the published npm package.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: ingwannu, lidge-jun

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the documentation-only change clarifying the local Bun requirement for source development.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

lidge-jun added a commit that referenced this pull request Jul 26, 2026
Contributors kept hitting a confusing gap: the npm package ships its own Bun
runtime, so `ocx` works without a local install, but every source-checkout
command runs through the contributor's own `bun`. State that explicitly at all
three entry points — the root contributor guide, the README development
section, and the hosted contributing docs.

Adds a regression test that compares each file's whole requirement paragraph
after whitespace normalization. Matching scattered fragments would keep passing
after the explanatory sentence is deleted, and would break on an innocuous
paragraph rewrap; normalized whole-paragraph comparison fails for the right
reason and survives reflow.

Verified: fails with the doc patch reverted, passes with it applied, still
passes after rewrapping the paragraph, and fails again when the substantive
sentence is removed.

Co-authored-by: CooperSheroy <sheroycoops@gmail.com>
@lidge-jun

Copy link
Copy Markdown
Owner

Integrated into dev as 803807a4 with your authorship preserved via Co-authored-by. Closing this PR since the change is now on the integration branch.

Your three paragraphs went in unchanged — the wording correctly separates contributor commands from the npm package's bundled runtime, and it doesn't contradict the end-user install section further up in README.md. Thank you for catching a gap that trips up first-time contributors.

I added one regression test on top, tests/docs-bun-source-requirement.test.ts. My first attempt matched scattered fragments per file, and an independent review caught that this would keep passing after someone deleted the explanatory sentence, as long as the words survived elsewhere in the file — a test that can't fail for the reason it exists. It also would have broken on a harmless paragraph rewrap. The version that landed locates the paragraph, normalizes its whitespace, and compares the complete paragraph.

Verification, in order: fails with your doc patch reverted, passes with it applied, still passes after rewrapping the paragraph across different line breaks, and fails again when the substantive sentence is removed. Full gates on the integration commit: bun run typecheck clean, privacy:scan clean, and the full suite at 4324 passing across three batches.


Integrated as part of a maintainer PABCD pass. Plan unit: devlog/_plan/260726_pr_close_rework/010_wp1_docs_bun_requirement_437.md.

@lidge-jun lidge-jun closed this Jul 26, 2026
lidge-jun added a commit that referenced this pull request Jul 26, 2026
통합(dev push 완료): #437 803807a, #460 74ddd96, #431 82a47db,
#405 be16c1d, #468 후속 테스트 bcaf029.

close: 통합 4건 + 통합 없이 1건(#459, 설계 충돌). #457은 OPEN 유지.
이슈 close 0건 — dev에서 고쳐졌는데 안 닫힌 이슈가 없었다.

무효화: WP4(#466)와 WP6(#467)은 동료가 직접 머지했고, 우리 분석이
지적한 결함을 동료 커밋이 같은 방향으로 해소했다.

보안 보류 5건에 신규 발견 게시: #429 재분류, #355 OAuth 토큰 목적지,
#424 유료 브리지 기본 ON, #408 설치 락 해제, #403 4분할 요청.

A-gate는 사이클마다 3~5라운드를 돌았다. 반복된 원인은 계획서에
테스트나 코드를 적으면서 실물 소스를 확인하지 않은 것이었다.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants