Programming

17488 readers

110 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 1 year ago

MODERATORS

snowe

Ategon

[email protected]

How common is it to code review like this? (self.programming)

submitted 8 months ago* (last edited 8 months ago) by slardiaardvark to c/programming

40 comments fedilink hide all child comments

For non-trivial reviews, when there are files with several changes, I tend to do the following in Git:

Create local branch for the pr to review
Squash if necessary to get everything in the one commit
Soft reset, so all the changes are modifications in the working tree
Go thru the modificiations "in situ" so to speak, so I get the entire context, with changes marked in the IDE, instead of just a few lines on either side.

Just curious if this is "a bit weird", or something others do as well?

(ed: as others mentioned, a squash-merge and reset, or reset back without squashing, is the same, so step 2 isn't necessary:))

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 8 points 8 months ago (1 children)

In my experience, I prefer to review or contribute commits which are logical changes that are compartmentalized enough that if needed, they could be reverted without impacting something completely differently. This doesn't mean 1 commit is always the right number of commits in a PR.

For example, if you have a feature addition which requires you to update the version of a dependency in the project, and this dependency update breaks existing code, I would have two commits, being:

Update dependency and fix issues because of the upgrade
Add new feature using new dependency

When stepping through the commits in the PR or looking at a git blame, it's clear which changes were needed because of the new dependency, and which were feature additions.

Obviously this isn't a one size fits all, but if someone submitted a PR with 12 commits of trial and error, and the overall changes are like +2 lines -3 lines, I'd ask them to clean that up before it gets merged.

[–] [email protected] 2 points 8 months ago (1 children)

You can squash merge so it goes into the main branch as one commit, that's usually how I do it.

[–] [email protected] 3 points 8 months ago

Right, for junior devs or trivial changes, that's fine. My take is if I'm going to make someone take the time to review my work, I take the time to make sure that it's cleaned up and would be something I would merge if I were reviewing it. Most of this comes from working on some larger Open Source projects which still require patches be submitted via email which I know is a real "back in my day" moment, but it did instil good practices which I try to carry on.