Skip to main content
Share Your Experience: Take the 2024 Developer Survey
182 votes
Accepted

Should I submit a pull request to correct minor typos in a Readme file?

Just fix all the typos you noticed and create a pull request with a comment along the lines of 'Fix typos'. Then it's one button to click for a person with the correct access. You don't need to ...
RiaD's user avatar
  • 1,700
56 votes

Should I submit a pull request to correct minor typos in a Readme file?

Some context that may or may not be relevant. A cloud hosting provider named DigitalOcean hosts an event every year called Hacktoberfest to encourage people to contribute to open source projects in ...
Zach Lipton's user avatar
  • 1,608
48 votes
Accepted

Code review workflow where pull request author must merge

In the first case, it's usually a courtesy. In most organizations, merges kick off a series of automated tests which must be dealt with promptly if they fail. Especially if there was a significant ...
Karl Bielefeldt's user avatar
31 votes
Accepted

I accidentally overhauled someone's entire project. Any acceptable way to pull request?

If the project was "5 years untouched" as you wrote, it is likely that pull requests are not going to be accepted, regardless if someone fixed a typo in a comment or did a complete rewrite. The ...
Doc Brown's user avatar
  • 209k
29 votes
Accepted

Why use pull requests instead of merging

Pull requests provide for checks and balances, even if anyone can push to master. The biggest advantage is that they provide an opportunity for code review. The person that is responsible for ...
Thomas Owens's user avatar
  • 83k
28 votes
Accepted

How to handle a TODO in a pull request?

When you say that they "generally stay in the codebase for the lifetime of the codebase" in your team/department/organization, consider the following: Write it down in your DoD that TODO, FIXME, or ...
beatngu13's user avatar
  • 483
24 votes
Accepted

Should we use Reject or Wait For Author in TFS when there are things to be fixed?

As per Microsoft on Review code with pull requests: Vote on changes the suggested purpose of each class of approval is: Approve with suggestions : Agree with the pull request, but provide optional ...
Peter M's user avatar
  • 2,039
15 votes

Should I submit a pull request to correct minor typos in a Readme file?

Correct the typos and submit a pull request with the position of each correction in the summary field. That information is already visible when looking at the changes themselves, and any pull request ...
Flater's user avatar
  • 51.7k
14 votes
Accepted

Are pull requests the place for training juniors

No. Pull requests are not the place for training. Your team has the right idea. A PR means "I think it's good to go. Can I get a 2nd set of eyes on this in case I missed something. I'm human after all....
RubberDuck's user avatar
  • 8,961
13 votes
Accepted

Why can't Pull Requests be seriously implemented in Mercurial?

You should probably read through the PEP yourself. Either Larry Hastings is confused or something was lost in communication. The reasons for moving to git and github over mercurial are not technical,...
Karl Bielefeldt's user avatar
11 votes
Accepted

If PRs are not being approved, when do you stop branching off of master?

I have a lot of code that is not merged to master/main This is a "management smell". It signifies that continuous integration has not been so continuous. Sometimes it's unavoidable - there'...
pjc50's user avatar
  • 13.6k
10 votes

Are pull requests the place for training juniors

If code that violates core design principles or standards of the team makes it to the pull request stage, then it should definitely be addressed there. And code reviews can be a good means of ...
JohnMcG's user avatar
  • 1,737
8 votes

Why use pull requests instead of merging

Having done both feature branching and forks + pull requests I think that pull requests offer little advantage when you all are developing in the same team or company They do offer a good mechanism ...
Ewan's user avatar
  • 76.4k
8 votes

How to manage pull request review and approvals

Reviewing pull requests is part of your team's work. If you as a team decided that PRs are needed (and that they need to be reviewed by 2 developers), then they are just as important as writing the ...
mmathis's user avatar
  • 5,488
8 votes
Accepted

Is it necessary to understand the requirements of a change in order to perform an effective code review?

One of the main reasons for code review is "does it do what it is supposed to do?" Without knowing requirements (and, thus, intent) for the code you can only do a formal analysis of the code ...
tofro's user avatar
  • 901
8 votes
Accepted

Should PR reviews check for code correctness?

There is more than one way to shave a cat. In an ideal organization which has a good testing process, and where only experienced developers work who regularly write unit tests, you can leave ...
Doc Brown's user avatar
  • 209k
7 votes

Code review workflow where pull request author must merge

Having the initial author merge their own pull request is my preferred workflow in small teams. In addition to technical advantages already mentioned (in terms of resolving merge conflicts, for ...
mkcor's user avatar
  • 171
7 votes
Accepted

How to review a pull request?

There are procedural tasks to be performed in a code review: That the code abides to the coding standards agreed upon by the team. That it is complete regarding unit tests, documentation, etc. Others ...
Apalala's user avatar
  • 2,283
7 votes
Accepted

How should my team distribute checking pull requests?

A team of 10 is approaching the large side for an agile team, but you can still keep the pull requests manageable if you make a rule that people can merge after two thumbs ups. That means for every ...
Karl Bielefeldt's user avatar
7 votes

Should I submit a pull request to correct minor typos in a Readme file?

Not that this specifically answers the question, as there are already answers, but here is the general advise I give people on commits and messages. Break up commits into logical chunks. The example I ...
Ben's user avatar
  • 179
7 votes

Are small pull requests better than one large all-encompasing features, and how can I convince my team of that?

Note that without concrete numbers and sizes, it's hard to give you an objective judgment on who is wrong and who is right. Maybe their tickets are too big, maybe you're making your changesets too ...
Flater's user avatar
  • 51.7k
7 votes

How can we reduce the PR load on our team?

In this case each PR has to be approved by five reviewers. This is your biggest problem. Reduce this number to two or at absolute maximum, three. If you don't trust that two developers on your team ...
Philip Kendall's user avatar
6 votes

Why use pull requests instead of merging

There is an observation called Conway's Law which states: organizations which design systems ... are constrained to produce designs which are copies of the communication structures of these ...
Karl Bielefeldt's user avatar
6 votes
Accepted

does it make sense to create a pull request without code

You don't need changed code to open a pull request, but you do need a branch, because the intent is to eventually push some code, even if that intent doesn't always materialize. Using a pull request ...
Karl Bielefeldt's user avatar
5 votes

Are pull requests the place for training juniors

I would phrase it more as pull requests shouldn't be the only place you train people. Also, junior developers aren't the only ones who may need some training in a pull request. Contractors, open ...
Karl Bielefeldt's user avatar
5 votes
Accepted

Create a pull request to a tag

A tag is a named reference to a commit that cannot be moved (without deleting and re-tagging). A branch is a reference to a commit that can be moved forward to track development. So while you can make ...
Samuel's user avatar
  • 9,197
5 votes

two level code review using git pull request in BitBucket

I see two ways you could handle this. Set up a second pull request after the first one is successful, making sure not to complete the first PR and merge it in. Downside here is the possibility that ...
mmathis's user avatar
  • 5,488
5 votes

How to handle a TODO in a pull request?

TODO's them selves are not evil. I am a big fan of never going more then one layer deep, and always fixing 1 issue per tracker ticket. I often use TODO or FIXME as a way to remind my self that I ...
coteyr's user avatar
  • 2,533
5 votes

Waiting on Multiple GitHub PR Merges

Create your 'continue working' branch (whatever that's going to be called), and cherry-pick the other PR changes in. (You could merge, but it'll get messy if you later need to address review comments ...
OJFord's user avatar
  • 249
5 votes
Accepted

What is the most effective way to explain code in a code review using a pull request?

There are a few options. One option is to utilize GitHub issues and ensure that every PR is associated with an issue. This gives you the opportunity to prioritize work, a singular place to talk about ...
Thomas Owens's user avatar
  • 83k

Only top scored, non community-wiki answers of a minimum length are eligible