A Quick Guide to Efficient Code Reviews
Hi, I'm Emi 👋
Software Engineer, TL at Modus Create
Volunteer at JSHeroes
@emi_codes
💻
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄 → ✅
More meaningful variable name?
I think you forgot to...
+ 📝
+ 👨🏽👨🏼👩🏻
→ ✅
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄 → ✅
The Reviewers
The Description
The Turnaround
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄 → ✅
The Description
The Description
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄 → ✅
The Reviewers
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄 → ✅
The Reviewers
💻 + 📝 + 🤖👨🏽👨🏼👩🏻 + 🔄 → ✅
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄 → ✅
The Turnaround
The Turnaround
Avoid focusing on nitpicks: integrate tools for formatting, linting, commit messages, etc. that check those things in a pre-commit hook
Have a style-guide that the team agrees on.
The Turnaround
Document what's expected from a PR. Create a PR checklist.
The Turnaround
Review with empathy. Ask for clarifications. Explain your reasoning.
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄
💻 + 📝 + 👩🏻👨🏽👩🏼
💻 + 📝 + 👩🏽👨🏼 + 🔄
💻 + 📝 + 👨🏽👨🏼👩🏻 + 🔄
💻 + 📝 + 👩🏽👨🏼 + 🔄
💻 + 📝 + 👩🏻👨🏽👩🏼
💻 + 📝 + 👩🏼👨🏽👩🏻👨🏼
💻 + 📝 + 👩🏼👨🏽👩🏻👨🏼
💻 + 📝 + 👩🏻👨🏽👩🏼
💻 + 📝 + 👩🏼👨🏽👩🏻👨🏼
💻 + 📝 + 👩🏼👨🏽👩🏻👨🏼
The Bottleneck
Takeaways
✍️ Add a good PR description that provides context
🤖 Introduce automation (code review bots, reminders, etc)
✅ Have a code review checklist
💙 Good code review culture is rooted in empathy
Thank you!
slides.com/emiliamuresan/code-reviews
Links & References:
- PullPanda: https://pullreminders.com/ (in the process of being integrated by Github)
- Code Dog: https://code-dog.app/
- Bitbucket Cloud: https://confluence.atlassian.com/bitbucket/bitbucket-cloud-for-slack-945096776.html
- https://slack.engineering/how-about-code-reviews-2695fb10d034
- https://www.freecodecamp.org/news/how-to-automate-code-reviews-on-github-41be46250712/
A quick guide to efficient code reviews
By Emilia Muresan