Code Review and PR Tips

Transcript

1. Pull Request & Code Review Alexander Kustov - 2016 Adapted from @jcinnamond and more
2. Pull Requests! What’s the point? - Detect bugs - Improve communication - Save time/money...
3. What’s the point? - Detect bugs - Improve communication - Save time/money... Pull Requests!
4. What’s OUR point? - Detect bugs - Improve communication - Save time/money... Pull Requests!
5. 1 Team Motivations What do we want when we PR
6. Measure and adapt based on results Results Outcome Expectations
7. 2 How? What to explain about your change
8. Place your screenshot here What’s a perfect pull request?
9. Github says: Purpose Usually in the title: - This simplifies the display of… - This fixes handling of… Overview People may not be familiar at all with this part of code Tone In OSS the whole world can see your PR, in your company maybe too, set your tone to inform the ones you want to... Request feedback If not sure, ask for help Suggest a path Where to start if you just landed on this PR? Keep it readable Less than 400 lines is good https://github.com/blog/1943-how-to- write-the-perfect-pull-request
10. 3 Who? Reviewing code is inherently social
11. Who should review? Usually everyone.
12. If not follow a path, or one of the paths Randomly assigned person, or two of them Lead Dev / Gatekeepers Junior Develo pers
13. 4 What? What’s good or bad in a review
14. “ Explain the problem, don’t criticise the code.
15. Code Review Not Personal Being right is not important in a code review. If it works, it doesn’t mean it can’t work better Suggest Improvements, styling changes, more specific methods But don’t dictate them Just Talk Sometimes commenting on code is not enough, Reach out to your friend on Slack or pair up and explain the best solution https://blog.codinghorror.com/code- reviews-just-do-it/
16. That’s it Go and crush some bugs
17. Summary 1. Team Motivation 2. Proper Guidelines of PR 3. Let everyone review 4. Make informative suggestions, or just talk
18. Thanks! Any questions?
19. HAPPY HACKING