Skip to content

Discourage force pushes #7960

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
merged 2 commits into from
Jan 29, 2025
Merged

Discourage force pushes #7960

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0954760
Discourage force pushes
penalosa Jan 29, 2025
b78e02e
Update CONTRIBUTING.md
penalosa Jan 29, 2025
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
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ Tests in a workspace are executed, by [Vitest](https://vitest.dev/), which is co

Every change you make should be stored in a [git commit](https://github.com/git-guides/git-commit).
Changes should be committed to a new local branch, which then gets pushed to your fork of the repository on GitHub.
In general, we discourage force pushing to branches, so please try and make your changes in additive commits. This makes reviewing easier, and is especially helpful when a PR goes through multiple rounds of review for a reviewer to be able to quickly see what's changed.
Copy link
Contributor

@petebacondarwin petebacondarwin Jan 29, 2025

Choose a reason for hiding this comment

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

Force pushes are not strictly the problem. For example you must force push when you rebase your PR on main.
What we want to discourage in prematurely updating or squashing commits that have already been reviewed.
The best practice is to use --fixup commits IMO, which helps to show which commits new changes would have affected.

Copy link
Contributor

@petebacondarwin petebacondarwin Jan 29, 2025

Choose a reason for hiding this comment

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

Also, during the period before the PR is marked as "ready for review" and someone has actually done a first review, we should actively encourage people to clean up and squash their commits into sensible changes, with force pushes as necessary, so that it is easier for the first reviewer to follow along.


- Ensure your `main` branch is up to date
```sh
Expand Down
Loading