tiny-pilot / tinypilot

Use your Raspberry Pi as a browser-based KVM.
https://tinypilotkvm.com
MIT License
3.02k stars 252 forks source link

Make Pro-merge instructions more actionable and self-documenting #1774

Closed jotaen4tinypilot closed 6 months ago

jotaen4tinypilot commented 6 months ago

I thought we could make our merge instructions for the Pro repo a little bit more actionable and self-documenting.

We can also set the reviewers field, to automatically assign the actor as reviewer. That way, the PR e.g. shows up in your “Requested Reviews” list.

See below how the PR description would look.


Related #123

@jotaen4tinypilot, please merge your changes from the Community repository:

  1. Update this branch with latest master
    • If there are merge conflicts, it’s best to resolve them locally.
  2. Check whether you need to make any Pro-specific adjustments to the code
  3. Review and approve your changes
    • You usually do this yourself. In case you had to make non-trivial adjustments, it’s also okay to request a proper peer review.
  4. Set the merge style to “Create a merge commit” (regular merge)
    • Do not use “Squash and merge”! If you accidentally squash, it’s not a disaster, but it will create a bit of noise on the subsequent PR from Community.
    • We want a regular merge to preserve the commit history from Community
  5. Merge the PR

Note that Github remembers the merge style of your last PR in this repo, so for your next “regular” PR, you may have to manually set it to “Squash and merge” again.

Review on CodeApprove

jotaen4tinypilot commented 6 months ago

Huzza