docs: clarify Bun requirement for source development#437
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughDevelopment documentation now states that contributors need the ChangesContributor Bun prerequisites
Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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>
|
Integrated into 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 I added one regression test on top, 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: Integrated as part of a maintainer PABCD pass. Plan unit: |
통합(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라운드를 돌았다. 반복된 원인은 계획서에 테스트나 코드를 적으면서 실물 소스를 확인하지 않은 것이었다.
Summary
bunCLI onPATHValidation
git diff --checknode/npmbut nobunbinary onPATH.Summary by CodeRabbit
PATH.