Getting Started with Conventional Comments Helper

The Problem

Code reviews are crucial for maintaining code quality, but they often suffer from:

Ambiguous or unclear feedback
Misunderstandings about comment severity
Difficulty in parsing and tracking different types of feedback
Inconsistent commenting styles across team members

What are Conventional Comments?

Conventional Comments is a standardized format for code review comments that helps teams communicate more effectively. It uses a simple syntax to categorize comments and indicate their importance:

[label] (decorator) comment text

For example:

[suggestion] (non-blocking) Consider using a more descriptive variable name
[issue] (blocking) This could cause a memory leak
[praise] Great job on the error handling!

Why Use Conventional Comments?

Clarity: Each comment's purpose and severity is immediately clear
Consistency: Team members follow the same commenting patterns
Efficiency: Reviewers can quickly scan and prioritize comments
Actionability: Authors know exactly what needs to be addressed
Automation: Tools can parse and categorize comments automatically

How Our Extension Helps

The Conventional Comments Helper extension makes it easy to:

Add standardized labels to your comments
Include decorators for additional context
Maintain consistent formatting
Toggle between plain text and badge-style formatting

Ready to get started? Head over to the Installation guide to set up the extension.