DEV Community

Cover image for Conventional Comments: Stop Fighting in Code Reviews

Conventional Comments: Stop Fighting in Code Reviews

Leonardo Montini on February 13, 2024

I’m sure you’ve heard about conventional commits, but what about conventional comments? The Problem Code Reviews can go terribly wrong....
Collapse
 
husseinkizz profile image
Hussein Kizz

this is really nice, but if there was something like an IDE extension for vscode that can help give these comment conventions snippets easily, people can then use this convention more, I also started to use conventional commits only when I met this tool: github.com/Everduin94/better-commits I wish something too for comments but not a CLI just an extension perhaps!

Collapse
 
balastrong profile image
Leonardo Montini

That's a really good idea! As of today we have the official vscode extension where you can review PRs but I don't think we can request to add conventional comments there.
I don't know if it's actually possible to build something third-party on top of that though, it would be nice!

Collapse
 
husseinkizz profile image
Hussein Kizz

Well please do work around it, there already some comment extensions out there but they don't fully have a known convention, for example I use better comments, it just highlights comments depending on keywords I use in the comment, then comment anchor helps me track comments across codebase etc, these little things make dev life happier!

Collapse
 
nickytonline profile image
Nick Taylor

I'm a big fan of conventional comments. 👏

Jack Nicholson nodding yes

Collapse
 
balastrong profile image
Leonardo Montini

Great! I'm going to use it at work and see what happens :D

Collapse
 
canro91 profile image
Cesar Aguirre

I used Conventional Comments for a past client and noticed that slowly other team members started to use it too.

Collapse
 
get_pieces profile image
Pieces 🌟

Maybe I should try conventional comments. Thanks for this! 👏

Collapse
 
balastrong profile image
Leonardo Montini

Definitely worth a try :D

Collapse
 
finneganbrock profile image
Finnegan Brock • Edited

Thank you so much for the solution. Dear student, do you need help with your academic papers? I am sharing my gem with you all, which is canadianwritings.com/ CanadianWritings. Their team of experienced writers can assist with essays, research papers, dissertations, and more. I've used their services and was impressed with the quality of work and their professionalism. Highly recommend!