Skip to content

Clarify git workflow: push to PR branch, don't create separate branches #33963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PureWeen merged 4 commits into from
Feb 25, 2026
Merged

Clarify git workflow: push to PR branch, don't create separate branches #33963

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbe88fb
Clarify git workflow: push to PR branch, don't create separate branches
StephaneDelcroix Feb 9, 2026
24ae5d4
Address review comments: rephrase rule #2, fix push contradiction, gr…
StephaneDelcroix Feb 12, 2026
a7f6913
Address review feedback: reconcile push guidance in git workflow rules
StephaneDelcroix Feb 24, 2026
541d652
Consolidate duplicate git workflow sections and apply minor wording i…
PureWeen Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ When working with public API changes:

1. **NEVER commit directly to `main`** - Always create a feature branch for your work. Direct commits to `main` are strictly prohibited.

2. **Do NOT rebase, squash, or force-push** unless explicitly requested by the user. These operations rewrite git history and can cause problems for other contributors. Default behavior should be regular commits and pushes.
2. **When amending an existing PR, work on the PR's branch directly** - Do NOT create a separate branch off a PR branch. The PR branch already IS a feature branch. Creating a new branch off it means CI won't run on the original PR, defeating the purpose. Use `gh pr checkout` to switch to the PR branch, make your changes, commit, **then** ask before pushing so the user can review locally first.

3. **When amending an existing PR, do NOT automatically push** - After making changes to an existing PR branch, ask the user before pushing. This allows the user to review the changes locally first. Exception: If the user's instructions explicitly include pushing, proceed without asking.
3. **Do NOT rebase, squash, or force-push** unless explicitly requested by the user. These operations rewrite git history and can cause problems for other contributors. Default behavior should be regular commits and pushes.

**Safe Git Workflow:**
```bash
Expand All @@ -157,9 +157,16 @@ git push
```

**When asked to update an existing PR:**
1. Make the requested changes
2. Stage and commit the changes
3. **STOP and ask the user** before pushing: "Changes are committed locally. Would you like me to push these changes to the PR?"
```bash
# Check out the PR branch directly (do NOT create a new branch off it)
gh pr checkout 12345

# Make fixes and commit to the PR branch
git add .
git commit -m "Fix: Description of the change"
```
1. **STOP and ask the user** before pushing: "Changes are committed locally. Would you like me to push these changes to the PR?"
2. Exception: If the user's instructions explicitly include pushing, proceed without asking.

### Documentation
- Update XML documentation for public APIs
Expand Down