Skip to content

Forbid pushing to origin in AGENTS.md#5344

Open
AntoineRichard wants to merge 2 commits intoisaac-sim:developfrom
AntoineRichard:antoiner/docs/agents-no-push-origin
Open

Forbid pushing to origin in AGENTS.md#5344
AntoineRichard wants to merge 2 commits intoisaac-sim:developfrom
AntoineRichard:antoiner/docs/agents-no-push-origin

Conversation

@AntoineRichard
Copy link
Copy Markdown
Collaborator

Description

The origin remote points to the public isaac-sim/IsaacLab repo. Agents and contributors should push to their own fork remote or to the remote of the PR they are working on instead.

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

The origin remote points to the public isaac-sim/IsaacLab repo.
Agents and contributors should push to their own fork remote
or to the remote of the PR they are working on instead.
The workflow now explicitly requires running pre-commit checks
before pushing, not just before committing. Adds a "don't push
before running pre-commit" warning to the common mistakes list.
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 21, 2026

Greptile Summary

This PR updates AGENTS.md with two additional guidelines: (1) a hard rule forbidding pushes to the origin remote (the public isaac-sim/IsaacLab upstream) and directing contributors to push to their own fork or PR branch instead, and (2) an expanded pre-commit section that spells out the correct step-by-step workflow (run ./isaaclab.sh -f, stage any auto-modified files, re-run, then commit). Both additions align with the project's existing custom rules and do not touch any source code.

Confidence Score: 5/5

Safe to merge — documentation-only change with no source or config modifications.

All changes are prose additions to AGENTS.md. Both new guidelines (no-push-to-origin and pre-commit workflow) are correct, consistent with the project's custom rules, and have no correctness risk.

No files require special attention.

Important Files Changed

Filename Overview
AGENTS.md Documentation-only update: adds "never push to origin" rule and expands pre-commit workflow instructions; no issues found.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Make code changes] --> B[Run ./isaaclab.sh -f]
    B --> C{Pre-commit modified files?}
    C -- Yes --> D[Review changes & git add]
    D --> E[Run ./isaaclab.sh -f again]
    E --> F{All checks pass?}
    F -- No --> B
    F -- Yes --> G[git commit]
    G --> H{Push target?}
    H -- fork/PR remote --> I[git push your-fork branch]
    H -- origin --> J[FORBIDDEN: Do not push to origin - isaac-sim/IsaacLab is public upstream]
Loading

Reviews (1): Last reviewed commit: "Enforce pre-commit before pushing in AGE..." | Re-trigger Greptile

Copy link
Copy Markdown

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

Choose a reason for hiding this comment

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

🤖 Isaac Lab Review Bot

Summary

This PR adds two important safety guidelines to AGENTS.md: (1) requiring pre-commit checks before pushing (not just before committing), and (2) prohibiting pushes to origin (the upstream repo). The implementation is clean and follows existing document conventions.

Architecture Impact

No cross-module impact — changes are self-contained documentation updates to AGENTS.md.

Implementation Verdict

Ship it — Clean, well-written documentation improvements that add valuable safety guardrails for AI agents and contributors.

Test Coverage

Documentation-only change — no tests required.

CI Status

All checks passing ✅

Findings

No issues found. The changes are clear, actionable, and consistent with the document's existing style.

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