Balakumaraa Puvanendran MBCS CITP CC CL’s Post

Sitting in a code review meeting. There is some code that I wrote included in the code review. Why? I wanted to get back closer to the actual development work and code base. It also helps me understand the developer experience. #writingcodefeelsgood

No matter which 𝗰𝗼𝗱𝗶𝗻𝗴 𝘀𝘁𝘆𝗹𝗲 you prefer, 𝗲𝗻𝗳𝗼𝗿𝗰𝗶𝗻𝗴 one is non-negotiable! Here's how to implement and 𝚎̲𝚗̲𝚏̲𝚘̲𝚛̲𝚌̲𝚎̲ ̲𝚌̲𝚘̲𝚍̲𝚒̲𝚗̲𝚐̲ ̲𝚜̲𝚝̲𝚊̲𝚗̲𝚍̲𝚊̲𝚛̲𝚍̲𝚜̲ effectively: 𝗔𝘂𝘁𝗼𝗺𝗮𝘁𝗲 𝘄𝗶𝘁𝗵 𝗖𝗜/𝗖𝗗: Use GitHub Actions to check formatting, catch warnings, run tests, and measure coverage on every push. 𝗜𝗺𝗽𝗹𝗲𝗺𝗲𝗻𝘁 𝗽𝗿𝗲-𝗰𝗼𝗺𝗺𝗶𝘁 𝗵𝗼𝗼𝗸𝘀: Catch style issues before they hit the repository. 𝗦𝘁𝗮𝗻𝗱𝗮𝗿𝗱𝗶𝘇𝗲 𝗲𝗻𝘃𝗶𝗿𝗼𝗻𝗺𝗲𝗻𝘁𝘀: Use pre-configured dev containers to ensure consistent development setups. 𝗟𝗲𝘃𝗲𝗿𝗮𝗴𝗲 𝘁𝗼𝗼𝗹𝘀: Black for formatting and SonarLint for code quality checks automate much of the process. 𝗠𝗮𝗻𝗱𝗮𝘁𝗼𝗿𝘆 𝗽𝗲𝗲𝗿 𝗿𝗲𝘃𝗶𝗲𝘄𝘀: All code must be reviewed by colleagues before merging. By integrating these practices into your workflow, you'll create a unified, maintainable codebase and focus on what really matters, building great software.

⚡ 4 Tips for Efficient Code Reviews 1. Allocate Focused Time ❌ Reviewing code haphazardly ✅ Set aside dedicated time for thorough code reviews 2. Use Code Review Tools ❌ Reviewing code without proper tools ✅ Use tools like GitHub PR reviews, Gerrit, or Crucible 3. Understand the Context ❌ Reviewing code without understanding its purpose ✅ Read the related issue or feature request to understand the context 4. Encourage Peer Reviews ❌ Only senior developers reviewing code ✅ Encourage peer reviews for diverse perspectives 🔁 Repost if you found this helpful and help others improve their code quality! ----- #SoftwareEngineering #CodeReviews #Tools #Technology #QualityAssurance #DevelopersLife #SoftwareTesting

Sometimes we skip the basics and dive straight into coding. But here's the truth: Understanding the API documentation upfront can save hours of debugging and confusion later. It’s your map to efficient development, better integrations, and fewer headaches. Let's take the time to read the docs. It's worth it! What’s your go-to strategy for understanding a new API?

Code reviews aren't doing what they're supposed to do. More often than not they're acting as a blocker for good code getting merged in and slowing down teams. In the next few weeks we'll be posting more info on just how much this is costing teams in productivity. But this much is certain - we need to rethink how we approach code reviews - https://lnkd.in/eS7cA_Dx

🔍 𝗚𝗶𝘁 𝗖𝗼𝗺𝗺𝗶𝘁 𝗠𝗲𝘀𝘀𝗮𝗴𝗲 𝗕𝗲𝘀𝘁 𝗣𝗿𝗮𝗰𝘁𝗶𝗰𝗲𝘀 🔍 Effective commit messages are key to a clean and maintainable codebase. Here’s a quick guide: 🛠️ 𝗨𝘀𝗲 𝗮 𝗖𝗼𝗻𝘀𝗶𝘀𝘁𝗲𝗻𝘁 𝗙𝗼𝗿𝗺𝗮𝘁 Adopt a standard structure for your commit messages 🔍  𝗖𝗼𝗺𝗺𝗼𝗻 𝗖𝗼𝗺𝗺𝗶𝘁 𝗧𝘆𝗽𝗲𝘀 feat: New feature fix: Bug fix docs: Documentation changes style: Code style changes (e.g., formatting) refactor: Code refactoring test: Testing-related changes chore: Maintenance tasks 🚀 𝗣𝗿𝗼 𝗧𝗶𝗽𝘀 Be Clear: Summarize the changes and their purpose. Be Concise: Keep it short and to the point. Use Imperative Mood: Write as if giving a command (e.g., “Fix bug”). Well-written commit messages enhance collaboration and make version history easier to navigate. 📝 #Git #CodingBestPractices #SoftwareDevelopment

Let’s go back to first principles. Every developer knows that small incremental code changes each day are better than one large complex change at the end of the week. And yet, I commonly see teams with 30-40% of their PRs with high PR complexity. Here’s a quick reminder of why we should stick to incremental changes: 📋 Faster feedback loops with stakeholders or users 📌 Higher quality code reviews from your team 🐛 Lower risk deployments when changes are small 📅 Problems are solved faster, because they’re caught sooner 📈Avoid scope creep (Did I miss any?) We all get it. Sometimes you’re just in the zone. You want to keep moving forward, and it’s just one more file that needs to be updated, then one more, and one last one. But go back to first principles and remember why this is best practice.

Code review gets time-consuming when you’re dealing with the “but it works on my machine” blocker. Everyone’s local dev environment will be unique; your team is likely working across different OSes and varying dependency versions. Unfortunately, for this reason, your local dev environment isn’t really a prime candidate for quick peer code reviews. Learn how branch-based deploys can enable on-the-spot code review (among many other things) ⬇ https://lnkd.in/gxnbJZYm

Making the code do what is expected is for the business... Writing clean code is for you and your colleagues... its your own legacy... Always strive to improve on the quality of work you give out... #code #softwaredevelopment

𝑻𝒉𝒆 𝑨𝒓𝒕 𝒐𝒇 𝑵𝒂𝒎𝒊𝒏𝒈 𝑪𝒐𝒏𝒗𝒆𝒏𝒕𝒊𝒐𝒏𝒔: 𝑪𝒍𝒂𝒓𝒊𝒕𝒚 𝑶𝒗𝒆𝒓 𝑪𝒐𝒎𝒑𝒍𝒆𝒙𝒊𝒕𝒚 Naming things in code—whether it’s a Git branch, commit, variable, method, or class—can be surprisingly challenging. I often find myself weighing different words and phrases to capture the high-level meaning without overcomplicating things. Here’s what I’ve learned: 𝗖𝗹𝗮𝗿𝗶𝘁𝘆 𝗶𝘀 𝗞𝗲𝘆: Choose names that clearly convey the purpose or function. Avoid ambiguity. 𝗖𝗼𝗻𝘀𝗶𝘀𝘁𝗲𝗻𝗰𝘆 𝗠𝗮𝘁𝘁𝗲𝗿𝘀: Stick to a consistent naming pattern across your project to enhance readability and maintainability. 𝗟𝗲𝘀𝘀 𝗶𝘀 𝗠𝗼𝗿𝗲: Aim for simplicity—long, overly descriptive names can be just as confusing as vague ones. Getting naming right might take a little extra time upfront, but it pays off in the long run by making your codebase easier to navigate and understand. Follow me for more!!! #CodingBestPractices #NamingConventions #SoftwareEngineering #CleanCode