Skip to content

docs: point contribution steps at the develop branch - #6940

Open
saime428 wants to merge 3 commits into
isaac-sim:developfrom
saime428:docs/contributing-target-develop
Open

docs: point contribution steps at the develop branch#6940
saime428 wants to merge 3 commits into
isaac-sim:developfrom
saime428:docs/contributing-target-develop

Conversation

@saime428

@saime428 saime428 commented Aug 6, 2026

Copy link
Copy Markdown

Description

The contribution guide tells contributors to open pull requests against main, which contradicts the pull request template:

Confirm the pull request base before submitting. Target develop for all contributions. The release/3.0.0-beta2 branch is a frozen stable landing snapshot and is not used for ongoing maintenance.

docs/source/refs/contributing.rst step 6 still reads:

6. Submit a pull request to the `main branch <https://github.com/isaac-sim/IsaacLab/compare>`__.

This is not a cosmetic mismatch. main receives only occasional docs and CI commits, while develop takes essentially all contributions — of the last 60 merged pull requests, 58 targeted develop, 2 targeted release/3.0.0-beta2, and none targeted main. A pull request opened against main therefore 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 labeler as 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

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added a changelog fragment under source/<pkg>/changelog.d/ for every touched package — not applicable, this PR touches no package under source/
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

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.
@saime428
saime428 requested a review from a team August 6, 2026 14:05
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 6, 2026

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 /compare URL does not encode develop, leaving the actionable link inconsistent with the revised instruction. The comparison URL should explicitly select develop as the base branch.

Minor fixes needed. Posted 1 actionable finding inline.

Automated review; human maintainers own approval decisions.

Comment thread docs/source/refs/contributing.rst Outdated
@greptile-apps

greptile-apps Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR updates the contribution guide to tell contributors to target develop instead of main.

  • Changes the branch name in the pull-request submission step.
  • Leaves the compare URL unqualified, so the linked GitHub page can still use main as its base.

Confidence Score: 4/5

The pull request should be corrected before merging because its link can still send contributors to a compare page based on main.

The wording changes to develop, but the bare GitHub compare URL continues to derive its base from the repository’s default main branch, leaving the documented workflow internally inconsistent and the original misrouting path reachable.

Files Needing Attention: docs/source/refs/contributing.rst

Important Files Changed

Filename Overview
docs/source/refs/contributing.rst Updates the documented PR target to develop, but does not update the compare URL to preselect that branch.

Reviews (1): Last reviewed commit: "docs: point contribution steps at the de..." | Re-trigger Greptile

Comment thread docs/source/refs/contributing.rst Outdated
@saime428

saime428 commented Aug 6, 2026

Copy link
Copy Markdown
Author

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. https://github.com/isaac-sim/IsaacLab/compare/develop... returns 404 (trailing ... with no head is not a valid compare ref).

/compare/{X} puts X in the head slot, not the base. I checked what each form actually selects:

URL base head
/compare release/3.0.0-beta2 release/3.0.0-beta2
/compare/develop release/3.0.0-beta2 develop
/compare/develop... 404 404
/compare/develop...develop develop develop

So /compare/develop would have left the base wrong while looking correct. I used /compare/develop...develop, which pins the base to develop and leaves the head for the contributor to switch to their fork branch.

Also, both review comments describe the repository default branch as main; it is currently release/3.0.0-beta2, which is what the bare /compare link was actually resolving to. That does not change the conclusion — the link was mis-targeted either way — but the specific branch named in the findings is wrong.

@saime428

saime428 commented Aug 7, 2026

Copy link
Copy Markdown
Author

The labeler job failed before any repository step ran because GitHub Actions could not download the action (Service Unavailable). I do not have permission to rerun it. Could a maintainer rerun the failed job?

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.

1 participant