<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Siya Ntombela on Medium]]></title>
        <description><![CDATA[Stories by Siya Ntombela on Medium]]></description>
        <link>https://medium.com/@siyantombela?source=rss-631e9f51e9d4------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/1*eu1JPuzVWWZG-TnoR046qQ.jpeg</url>
            <title>Stories by Siya Ntombela on Medium</title>
            <link>https://medium.com/@siyantombela?source=rss-631e9f51e9d4------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Mon, 16 Nov 2026 18:37:14 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@siyantombela/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[Code Review Etiquette: Writing Code Is Human, Reviewing Is Divine]]></title>
            <link>https://medium.com/@siyantombela/code-review-etiquette-writing-code-is-human-reviewing-is-divine-d1c6310f189a?source=rss-631e9f51e9d4------2</link>
            <guid isPermaLink="false">https://medium.com/p/d1c6310f189a</guid>
            <category><![CDATA[ettiquette]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[code-review]]></category>
            <dc:creator><![CDATA[Siya Ntombela]]></dc:creator>
            <pubDate>Tue, 08 Oct 2024 12:53:23 GMT</pubDate>
            <atom:updated>2024-10-08T12:53:23.732Z</atom:updated>
            <content:encoded><![CDATA[<p><em>Navigating the Art of Constructive Criticism in Software Development</em></p><p>Ever had that moment when your code review feels less like a helpful critique and more like a stand-up roast? You’re not alone. In the fast-paced world of software development, code reviews are essential — but they can sometimes be a source of tension and misunderstanding. Let’s explore how we can transform code reviews into positive, productive experiences that foster collaboration and improve code quality.</p><p><strong>Why Do We Put Ourselves Through This?</strong></p><p>Before we delve into the do’s and don’ts, let’s revisit why code reviews are a staple in our development process:</p><p>• <strong>Improve Code Quality</strong>: Catch bugs and errors early, ensuring robust and reliable software.<br> • <strong>Share Knowledge</strong>: Promote learning and spread expertise across the team.<br> • <strong>Foster Collaboration</strong>: Encourage teamwork and collective ownership of the codebase.<br> • <strong>Maintain Consistency</strong>: Uphold coding standards and best practices throughout the project.</p><p>“Code is read more often than it’s written — so let’s read and write nicely.”</p><p><strong>Horror Stories from the Repository</strong></p><p>We’ve all encountered code review nightmares. Here are some of the usual suspects:</p><p>🤐 <strong>The Silent Treatment</strong></p><p>No feedback given.</p><p>You’re waiting on feedback to merge your pull request, but all you hear are crickets. Silence can be frustrating and stalls progress.</p><p>🗣️ <strong>The Overloader</strong></p><p>Too much irrelevant feedback.</p><p>This reviewer floods your PR with comments, many of which are nitpicks or off-topic, making it hard to sift through what’s important.</p><p>🧐 <strong>The Nitpicker</strong></p><p>Focuses on trivialities.</p><p>They zero in on minor issues like spacing or semicolons, ignoring the bigger picture of functionality and design.</p><p>👻 <strong>The Ghost</strong></p><p>Disappears when it’s their turn.</p><p>When it’s time for them to review code or address feedback, they vanish into thin air, slowing down the workflow.</p><p><strong>The Golden Rules of Code Review Etiquette</strong></p><p>To avoid these pitfalls, let’s establish some ground rules.</p><p><strong>1. 🙏 Be Respectful</strong></p><p>Attack the code, not the coder.</p><p>Remember, there’s a human behind every line of code. Frame your feedback to focus on the work, not the person.</p><p><strong>2. 🛠️ Be Constructive</strong></p><p>Offer solutions, not just problems.</p><p>If you spot an issue, suggest a way to fix it. This turns a critique into a collaborative problem-solving effort.</p><p><strong>3. 🔍 Be Specific</strong></p><p>General feedback helps no one.</p><p>Vague comments like “This doesn’t look right” aren’t helpful. Point out exactly what’s wrong and why.</p><p><strong>4. ⏰ Be Timely</strong></p><p>Don’t let PRs gather dust.</p><p>Prompt reviews keep the project moving and show respect for your colleagues’ time.</p><p><strong>It’s Not What You Say, It’s How You Say It</strong></p><p>Communication is key in code reviews.</p><p>• <strong>Use Positive Language</strong>: Frame your comments in a way that encourages dialogue.<br> • <strong>Ask Questions:</strong> Instead of making demands, ask for clarification. For example, “Have you considered…?”<br> • <strong>Avoid Sarcasm and Jargon:</strong> These can be misinterpreted and create barriers.</p><p><strong>Balancing Criticism and Praise</strong></p><p>Think of feedback as a sandwich:</p><p>1. <strong>Praise</strong>: Start with something positive.<br> 2. <strong>Critique</strong>: Offer your constructive criticism.<br> 3. <strong>Praise</strong>: End with encouragement.</p><p>Example: “Great job on the function abstraction. One suggestion: consider optimizing this loop. Overall, the code is clean and readable.”</p><p><strong>Best Practices for Reviewers</strong></p><p>• <strong>Understand the Context</strong>: Read the entire PR and related documentation.<br> • <strong>Big Picture First</strong>: Look at the overall design before diving into details.<br> • <strong>Stay Objective:</strong> Base your feedback on facts and standards, not personal preferences.<br> • <strong>Respect Coding Styles:</strong> Accept that there are multiple ways to solve a problem (within reason).</p><p>Remember: Not everyone loves semicolons as much as you do.</p><p><strong>Best Practices for Authors</strong></p><p>• <strong>Provide Context: </strong>Write clear and detailed PR descriptions.<br> • <strong>Be Open-Minded:</strong> View feedback as an opportunity to learn, not a personal attack.<br> • <strong>Clarify When Needed:</strong> If something isn’t clear, don’t hesitate to ask for more information.</p><p><strong>The Art of Letting Go</strong></p><p>Sometimes, it’s okay to agree to disagree. Prioritize what’s best for the project and be willing to compromise.</p><p>“Perfect is the enemy of good — especially when the sprint ends tomorrow.”</p><p><strong>Tools and Techniques</strong></p><p>• Linters and Formatters: Automate style checks to focus reviews on substance.<br> • Code Review Checklists: Standardize the process to ensure consistency.<br> • Collaborative Tools: Utilize platforms that facilitate clear communication and tracking.</p><p><strong>Transforming Criticism into Constructive Feedback</strong></p><p><strong>Before</strong>: “This function is a mess.”</p><p><strong>After</strong>: “Could we refactor this function to improve readability and maintainability?”</p><p>By rephrasing, you open up a constructive dialogue rather than shutting it down.</p><p>Let’s Make Code Reviews a Positive Experience</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*WCGnzN_p9Wu3kOJoq_f_WQ.jpeg" /></figure><p>By following these guidelines, we can turn code reviews from dreaded chores into valuable team-building exercises that enhance our code and our collaboration.</p><p>“<em>Remember, every line of code tells a story — let’s be good editors.”</em></p><p>Questions? Thoughts? Jokes about semicolons? Feel free to share in the comments below!</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=d1c6310f189a" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>