Repository navigation
docs: add CONTRIBUTING notes for CI caching and subprocess test timeouts - #2322
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📜 Recent review details
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Title check |  |
The title is concise, scoped, and accurately describes the documentation changes for CI caching and subprocess test timeouts. |
| Description check | |
The description follows the required template and clearly documents the changes, impact, testing status, and notes. It records that the required local preflight was not run because this is a documenta… |
| Docstring Coverage | |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
| Risk Surface Disclosed | |
PASS — The PR changes only CONTRIBUTING.md. It adds guidance for test readiness, subprocess timeouts, and existing PR Checks dependency-cache behavior. It does not change auth, routing, permissions,… |
| No Hidden Policy Change | |
PASS — The PR changes only CONTRIBUTING.md and adds contributor guidance for async assertions, subprocess test timeouts, Bun cache behavior, frozen-lockfile installs, and local preflight requirement… |
Full details: Description check
-
Explanation
The description follows the required template and clearly documents the changes, impact, testing status, and notes. It records that the required local preflight was not run because this is a documentation-only change.
Full details: Docstring Coverage
-
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Full details: Risk Surface Disclosed
-
Explanation
PASS — The PR changes only
CONTRIBUTING.md. It adds guidance for test readiness, subprocess timeouts, and existing PR Checks dependency-cache behavior. It does not change auth, routing, permissions, outbound network behavior, background execution, startup/configuration, plugins/MCP, CI permissions, or release scripts. No listed risk surface or blocker is introduced.
Full details: No Hidden Policy Change
-
Explanation
PASS — The PR changes only
CONTRIBUTING.mdand adds contributor guidance for async assertions, subprocess test timeouts, Bun cache behavior, frozen-lockfile installs, and local preflight requirements. The diff introduces no product behavior, trust-model, routing default, telemetry/network, or permission-policy decision. No maintainer alignment is required for this check.
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
jatmn
left a comment
jatmn
left a comment
There was a problem hiding this comment.
— jatmn's PR Review agent
Standalone documentation follow-up for merged #2313 and #2316. The three added lines in CONTRIBUTING.md match the workflow and test patterns I checked on this head. I do not see a code or docs defect in the review diff; clear the merge-readiness items below before landing.
Merge readiness
- Rebase onto current
main. Livemainis1c42a106(fix(shell): honor an abort that lands before the listener is attached (#2321)). This head is one commit behind and mergeable_state isblockedwhile the PR remains a draft. Rebase (or mergemainforward) so the branch is current before merge. - Mark the PR ready for review. GitHub still lists this as a draft; branch protection will keep the merge gate blocked until it is marked ready.
- CI at head
1fcee819e0220b339da0bb4c4418cbda814dc95b:changesandpr-intent-scansucceeded. Markdown-only path filtering skippedsmoke-and-tests, all eightunit-testsshards,dedicated-tests,typecheck, launcher jobs, andweb(expected for a root.md-only diff perpr-checks.yml).CodeQL (actions)andAnalyze (javascript-typescript)succeeded. AggregateCodeQLisneutral(see automated review audit). At review timeCodeQL (javascript-typescript)was stillin_progress; wait for it to finish and confirm it does not fail before merge. - Preflight checkbox. The PR body leaves the local preflight box unchecked and notes
git diff --checkonly. That is acceptable for this docs-only delta given CI ranpr-intent-scan, but align the Testing section withCONTRIBUTING.mdValidation if you want the template to reflect the markdown-only CI skip policy explicitly.
Automated review audit
| Source | Thread / check ID | Status on head | Disposition |
|---|---|---|---|
| CodeRabbit | Issue comment #6330084057 | Summary comment only; review was in progress with no line findings | Nothing to promote; no actionable request yet |
| CodeQL (GitHub Advanced Security) | Check run 119576856726 | neutral — missing javascript-typescript configuration on the PR ref |
Drift, not a PR defect: docs-only change; 0 open code-scanning alerts on refs/pull/2322/head; no code finding |
| CodeQL Actions / Analyze | Runs on head | success |
No alerts to address |
Findings
🟢 Thanks for the contribution. I do not see any actionable issues from my review.
1 participant
Summary
CONTRIBUTING.mdfor two behaviors that landed without docs:bun.lock/web/bun.lock, installs stay--frozen-lockfileon cache hits, so lockfiles must stay in sync and the local preflight is still required regardless of cache status.Impact
Testing
git diff --checkclean. Docs-only change, so no code checks are affected.CONTRIBUTING.mdchanges; CI covers the rest.Notes
Summary by CodeRabbit