docs: point contribution steps at the develop branch - #6940
Conversation
The PR template states that all contributions target `develop`, but the contribution guide still tells contributors to open pull requests against `main`. `main` receives only occasional docs and CI commits, so PRs opened there sit without CI or review.
There was a problem hiding this comment.
Isaac Lab Review Bot
The contribution guide now names develop as the pull-request target, but its linked GitHub comparison page still defaults to the repository’s default branch rather than explicitly selecting develop.
- Design and architecture: The change is limited to one contribution-workflow instruction and does not affect code architecture, package layout, or documentation build integration.
- API: No public API, CLI, export, or configuration surface changes. No package changelog fragment is required for this documentation-only edit.
- Implementation: The visible branch name was updated, but the unchanged
/compareURL does not encodedevelop, leaving the actionable link inconsistent with the revised instruction. The comparison URL should explicitly selectdevelopas the base branch.
Minor fixes needed. Posted 1 actionable finding inline.
Automated review; human maintainers own approval decisions.
Greptile SummaryThe PR updates the contribution guide to tell contributors to target
Confidence Score: 4/5The pull request should be corrected before merging because its link can still send contributors to a compare page based on The wording changes to Files Needing Attention: docs/source/refs/contributing.rst Important Files Changed
Reviews (1): Last reviewed commit: "docs: point contribution steps at the de..." | Re-trigger Greptile |
|
Good catch on the link — fixed in d66d9ab. Two corrections to the analysis, though, for whoever reviews this next: The suggested URL does not exist.
So Also, both review comments describe the repository default branch as |
|
The |
Description
The contribution guide tells contributors to open pull requests against
main, which contradicts the pull request template:docs/source/refs/contributing.rststep 6 still reads:This is not a cosmetic mismatch.
mainreceives only occasional docs and CI commits, whiledeveloptakes essentially all contributions — of the last 60 merged pull requests, 58 targeteddevelop, 2 targetedrelease/3.0.0-beta2, and none targetedmain. A pull request opened againstmaintherefore gets no CI and no review attention, and the author has no signal that anything is wrong.I hit this myself: I followed this step for #6440, which then sat for a month with
labeleras the only check that ever ran.This changes the single word so the guide agrees with the template.
Fixes # (no issue opened — happy to file one if you would prefer that first)
Type of change
Checklist
source/<pkg>/changelog.d/for every touched package — not applicable, this PR touches no package undersource/CONTRIBUTORS.mdor my name already exists there