A Question on PR Etiquette

Keyman
1

Hello,

I’m writing to ask what the better practice is when a keyboard developer finds the need for an update -immediately following an update that was just merged.

In a, ahem, purely hypothetical situation, where just after a keyboard update has been merged, I discover a bug or have an inspiration for an enhancement, my instinct is to push out an update right away before too many people have downloaded the faulty version. This is motivated by the benefit to the keyboard user, and it minimizes the number of people impacted by the defect and the burden of making yet another update so soon after the previous one.

However, the Keyman keyboard reviewer team is small and overburdened, and yet another PR to process, so soon after the last, I imagine will not be met with delight :slightly_smiling_face: So maybe the hypothetical keyboard developer should hold off for a week or two, allowing the possibility to find and fix other issues as well.

What practice would be preferred? My thought now is to wait at least a week to submit an update for an enhancement or a minor bug. Then less time (24h? 48h?) for a major bug that somehow got thru and impacts regular composition for the majority of users.

Let me know if this practice would be ok, or needs adjustment. Likewise, please add any recommendations for keyboard developers to follow or avoid with PR submissions.

thanks!

-Daniel

2

My two bits:

  • If it needs fixing urgently, go ahead and fix it.
  • If it’s a nice thing to fix, but not urgent, wait and test it to see if you find other things before submitting a new PR.
  • If someone does an immediate PR after an approval, I always assume the author hasn’t done a good job testing their changes and it means in the future I feel I have to check their PRs more thoroughly which always delays checking.
2 Likes