Skip to content

docs(contributing): let changes that need each other share a pull request - #821

Merged
devswha merged 1 commit into
mainfrom
docs/dependent-changes-one-pr
Oct 11, 2026
Merged

devswha merged 1 commit into
mainfrom
docs/dependent-changes-one-pr

Conversation

@devswha

@devswha devswha commented Oct 11, 2026

Copy link
Copy Markdown
Owner

Change

CONTRIBUTING.md said "One change per PR" with no room for changes that cannot be split. It now also says that changes which cannot stand apart, because one needs another's code, may share a PR: each as its own commit, in dependency order, with the description saying what needs what.

Independent changes still go in independent PRs, and a stack is still a maintainer's call; this only covers the case where a second PR could not typecheck or pass its tests without the first (for example #820, where the telemetry change counts settings that the two commits before it add).

Validation

Prose only; no test.

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: devswha/herdr-web-ui/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 31bc2694-a312-4465-bdd9-305a7b050636

📥 Commits

Reviewing files that changed from the base of the PR and between cd5dc5d and 69fb9d0.


📒 Files selected for processing (1)
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.



📝 Summary

Summary by CodeRabbit

  • Documentation
    • Clarified that dependent changes may be submitted in one pull request when committed in dependency order and explained in the PR description. Existing squash-merge and title guidance remains.

Walkthrough

The pull-request guidance now allows dependent changes in one pull request if each change has a separate commit in dependency order and the description explains the dependencies. Existing squash-merge and title guidance remains.

Changes

Contribution guidance

Layer / File(s) Summary
Document dependent changes
CONTRIBUTING.md
The guidance permits dependent changes in one pull request when separate commits follow dependency order and the pull-request description explains the dependencies. Existing squash-merge and title guidance remains.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: jjliebig


Merge Risk: ⚪ Minimal · up to 69fb9

The guidance permits dependent changes to share a PR when separately committed in dependency order and documented; independent changes remain separate, with stacks under maintainer control. No material merge-readiness risk is evident.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the documentation change that allows dependent changes to share a pull request.
Description check Passed The description includes the required Change and Validation sections. It explains the new behavior, preserves the separate-PR rule for independent changes, and states that validation was prose-only.
Docstring Coverage Passed 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 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)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@devswha
devswha merged commit 1ee0ac1 into main Oct 11, 2026
9 checks passed
@devswha
devswha deleted the docs/dependent-changes-one-pr branch October 11, 2026 17:07
devswha added a commit that referenced this pull request Oct 11, 2026
## Change

Release 0.4.7, from main at 80ca9bb (47 PRs since v0.4.6).

- `package.json` and `herdr-plugin.toml`: 0.4.7.
- CHANGELOG: `[Unreleased]` becomes `[0.4.7] - 2026-10-12`, with the
compare links.
- #513's entry moves out of the 0.4.0 section, where its branch's merge
left it, and gets its credit; it says the pace is a setting, off by
default (#834).
- A Maintenance section covers the PRs that had no entry: #743, #756,
#767, #795, #805, #810, #813, #821, #826, #831.
- The note under the Hermes entry that asked for a runtime bump at
release now says what a remote PC needs.
- `release-summaries.json`: 0.4.7 in en/ko/ja/zh/tr (6 new, 6 improved,
5 fixed). The Turkish lines are not checked by a native speaker.
- `REMOTE_BUNDLE_VERSION` 25 -> 26. Since v0.4.5's runtime the bridge
gained Hermes transcripts (#604), conversation pushes (#689) and
Grok/Antigravity activity (#816), so `remote-v26` is published before
the app release.

Not in this release: #606.

## Validation

- `bun scripts/release-notes.ts 0.4.7` renders the summaries and the
full changelog (235 lines).
- `bun run typecheck` and `bun run build`: pass.
- `TMPDIR=/tmp bun run test:unit`: one failure, `server/voice.test.ts`
("audio.webm" vs "clip.webm"), which fails the same way on unmodified
`main` on this Mac (Bun 1.4.0); CI runs Bun 1.4.2.
- Every PR merged since v0.4.6 was checked against the changelog
section: all 47 are linked.

## Release

After this merges and its CI on `main` passes: push `remote-v26`, wait
for its release, then run the Release workflow with `0.4.7`.
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