Code review is @rt
Smaïne Milianni
@SmaineDev
SEPTEMBER 15 -16, 2022 - LILLE, FRANCE & ONLINE
🥋Trainer - Developer 🐛
1st Conference 🎉
Thanks 🌺
@SmaineDev
Do we need
Code Review?
@SmaineDev
@SmaineDev
🪞 Transparency
💫 Control overall quality
🏆 Level up
🧠 Prevent bugs and omissions
🏁 Validate changes
🏉 Team spirit and ownership
Code Review 👀 💻
@SmaineDev
📖 Log conversation
A good pull request helps to have a good code review
Pull Request 🪢
@SmaineDev
🗣️ Well described
🧵Focus / Scoped
✅ Well tested
💡 Highlighted
🪢 Perfect Pull Request 🔥
@SmaineDev
New changes appear... BUT
What
Why
How
Well described 🗣️
@SmaineDev
What
The title and commit message should explain the changes
Description can contain things such as screenshots, videos, gifs, etc.
Before / After comparison
Any details that help reviewers to have a better understanding
Well described 🗣️
@SmaineDev
Why
Link to the issue or Issue description
Well described 🗣️
@SmaineDev
How
Technical details about the implementation
Well described 🗣️
@SmaineDev
@SmaineDev
✂️ Separate feature and refactoring
⭕️ Focus on the purpose of the PR
🧩 Split in commit if needed
Focus / Scoped 🧵
@SmaineDev
🔨 Test the new code
😅 Ensure not to break existing tests
Well tested ✅
@SmaineDev
🗣 Comment changes yourself
🔦 Highlight interesting/critical part
Highlighted 💡
@SmaineDev
@SmaineDev
💡 Auto review first
Be reviewed 🔬
⚡️ Be proactive
🛡 Don't take it personally
✅ Green tests
@SmaineDev
@SmaineDev
👀 Read description
Open ticket/Figma, check tests, ask teammate...
Code review 🔍
💡 Understand what do you review
@SmaineDev
📚 Understand clean code
SOLID, KISS, DRY, YAGNI...
Code review 🔍
@SmaineDev
🐌 Review slowly
Code review 🔍
👋🏽 Approve a PR is giving consent 🖊 and engaging your responsibility
@SmaineDev
⚠️ Keep your attention to critical parts
Code review 🔍
Endpoint, Security, Business rules...
@SmaineDev
🕳 Identify problems before checking code style
Code review 🔍
Anticipate edge case, architecture layer,
Behavior in case of errors,
Exception handling
Performance, logs...
@SmaineDev
Code review 🔍
💻 Checkout locally and deep dive in code
Jump from class to class, check that most of the use cases are tested, complexity, consistency...
@SmaineDev
☀️ Be kind and respectful
Code review 🔍
👏 Give good points 🎉
👍 Make it fun
@SmaineDev
❓Don't be ashamed to ask questions
Code review 🔍
➕ Offer alternatives
🗣 Perform peer review if necessary
@SmaineDev
Tools 🛠
@SmaineDev
✍🏿 Pull request templates
Tools 🛠
@SmaineDev
## What
(Summarize the feature/bug)
## Why
[link to ticket/issue](www.jira_is_a_nightmare/project/42)
## How to?
## Relevant logs and/or screenshots
✍🏿 Pull request templates
Tools 🛠
@SmaineDev
🎨 Git commitizen
Tools 🛠
@SmaineDev
🤖 Pull request bot
Tools 🛠
@SmaineDev
Thank you! ✨
@SmaineDev
@SmaineDev