Github Pull Requests for Everyone

Reviewing a pull request can feel like a chore. If done poorly, PR reviews can mean a few hours of attempting to understand both the problem and the solution, then checking that the result matches the design. Sure, many of us have the luxury of walking to our coworker’s desk and getting a walk through. But what if the other dev isn’t free? What if they live in another time zone? What if you need a project manager or designer to look at your work, and they don’t have a local setup or much dev experience?

In this session, we’ll go over some tips and technologies to make your pull request process a bit smoother. We’ll discuss:
* Writing clear issues/stories to build a good foundation
* Tools you can use for reviewing work with remote coworkers
* Keeping design reviews from turning into blockers
* Adding testing instructions to your PR description
* Leaving positive feedback so no one goes home grumpy

This session is for you if your team uses Git, and….
* You have a coworker or client in a different timezone
* You regularly need a designer to review your work
* You or your coworkers work remotely one or more days a week
* You regularly contribute to open source projects (or run your own!)
* You ever have code that needs a merge, like, now

Transcript

1. GitHub Pull GitHub Pull Requests for Requests for Everyone Everyone tiny.cc/cmeade-gpr-repo tiny.cc/cmeade-gpr-repo speakerdeck.com/catheraaine speakerdeck.com/catheraaine 1
2. ✨ NEW BONUS FEATURE: ✨ ✨ NEW BONUS FEATURE: ✨ Code Reviews Code Reviews for Everyone for Everyone tiny.cc/cmeade-gpr-repo tiny.cc/cmeade-gpr-repo 2
3. Catherine Meade Catherine Meade DEVELOPER, SPARKBOX DEVELOPER, SPARKBOX she / her she / her @catheraaine @catheraaine 3
4. How Sparkbox Does How Sparkbox Does Code Reviews Code Reviews 4
7. RULE ONE RULE ONE No one merges their own code. No one merges their own code. 6
8. RULE TWO RULE TWO Never push directly to master. Never push directly to master. 7
9. RULE THREE RULE THREE If you are working with UI, get a If you are working with UI, get a design review. design review. 8
10. RULE FOUR RULE FOUR If you’re working on copy, get a If you’re working on copy, get a copy review. copy review. 9
11. RULE FIVE RULE FIVE Never, ever push directly to Never, ever push directly to master. master. 10
12. RULE SIX RULE SIX Rules are more like… Rules are more like… guidelines. guidelines. github.com/sparkbox/standard github.com/sparkbox/standard 11
13. Challenges of Collaboration Challenges of Collaboration 12
14. Write Good Stories Write Good Stories 13
16. Github Issue Templates Github Issue Templates via GitHub via GitHub tiny.cc/github-issue-templates tiny.cc/github-issue-templates 15
21. Github Issue Templates Github Issue Templates via GitHub via GitHub tiny.cc/github-issue-templates tiny.cc/github-issue-templates 19
22. Kasey Bonifacio, Sparkbox Developer Kasey Bonifacio, Sparkbox Developer "Writing Better Release Notes" "Writing Better Release Notes" tiny.cc/foundry-bonifacio tiny.cc/foundry-bonifacio 20
23. Get the Basics Right Get the Basics Right 21
29. We try to include: We try to include: A quick summary of the work being done. A link to any related stories or issues. A link or screenshot of the original design work. Step-by-step testing instructions. 25
32. Enhance Your Pull Enhance Your Pull Request: with Gif Request: with Gif 27
34. Gifs can be useful. Gifs can be useful. 29
35. Recordit Recordit recordit.co recordit.co 30
37. Recordit Recordit recordit.co recordit.co 32
38. Gifox Gifox gifox.io gifox.io
40. LICEcap LICEcap licecap.en.softonic.com licecap.en.softonic.com 34
41. Enhance Your Pull Enhance Your Pull Request: with Video Request: with Video 35
42. GoVideo by Vidyard GoVideo by Vidyard vidyard.com/govideo vidyard.com/govideo 36
44. GoVideo by Vidyard GoVideo by Vidyard vidyard.com/govideo/ vidyard.com/govideo/ 38
45. Give Valuable Give Valuable Feedback: Skitch Feedback: Skitch 39
46. Skitch by Evernote Skitch by Evernote evernote.com/products/skitch evernote.com/products/skitch 40
53. Skitch by Evernote Skitch by Evernote evernote.com/products/skitch evernote.com/products/skitch 46
54. More Feedback Feedback More Feedback Feedback Offer an alternative. Phone a friend. Choose which hills to die on. Keep the tone light. 47
56. Give Valuable Give Valuable Feedback: Be Nice Feedback: Be Nice 49
57. BRYAN BRAUN, SPARKBOX DEVELOPER, EAGLE SCOUT BRYAN BRAUN, SPARKBOX DEVELOPER, EAGLE SCOUT "Stop Giving Depressing Code "Stop Giving Depressing Code Reviews" Reviews" tiny.cc/foundry-braun tiny.cc/foundry-braun 50
58. “Giving positive feedback is an easy habit to adopt. You're already reading through the lines of code, looking for issues. It doesn't take much time to throw in a ‘Nice!’ or ‘Looks great!’ If you see something awesome, say it!” - Bryan Braun tiny.cc/foundry-braun 51
59. Be Nice. Be Nice. 52
60. ✨ Take the 2019 Sparkbox Design ✨ Take the 2019 Sparkbox Design Systems Survey ✨ Systems Survey ✨ bit.ly/sb-2019-survey 53
61. Thanks! Thanks! Catherine Meade Catherine Meade DEVELOPER, SPARKBOX DEVELOPER, SPARKBOX | cat@heysparkbox.com | cat@heysparkbox.com @catheraaine @catheraaine tiny.cc/cmeade-gpr-repo bit.ly/sb-2019-survey speakerdeck.com/catheraaine 54