Conventional Comments

Using Conventional Comments Helper

Basic Usage

  1. Navigate to any GitHub pull request or issue
  2. Click on the comment box
  3. Use the toolbar that appears above the comment box to format your comment
Settings related to Pullpo - PR Channels
Basic usage with badge mode (default) enabled

Available Labels

LabelDescriptionWhen to Use
[praise]Highlight something positiveWhen you want to acknowledge good work or practices
[nitpick]Minor, non-blocking issuesFor small, non-critical improvements
[suggestion]Suggest specific improvementsWhen you have a concrete improvement to propose
[issue]Point out blocking problemsFor critical issues that must be addressed
[question]Ask for clarificationWhen you need more information or context
[thought]Share a reflection or ideaFor general observations or ideas
[chore]Request minor, non-code tasksFor documentation or process-related requests

Decorators

DecoratorDescriptionWhen to Use
(non-blocking)Optional changesWhen the change is nice to have but not required
(blocking)Must be addressedWhen the change is critical and must be fixed
(if-minor)Address if the effort is smallWhen the change should only be made if it's quick

Writing Comments

  1. Click the comment box
  2. Select a label from the toolbar
  3. Optionally add a decorator
  4. Write your comment
  5. The extension will automatically format it

Example:

[suggestion] (non-blocking) Consider using a more descriptive variable name here

Removing Labels/Decorators

To remove a label or decorator:

  1. Click the label/decorator in the toolbar again
  2. Or manually delete it from the comment text

Format Options

The extension supports two display formats:

  1. Text Format: [label] (decorator) comment
  2. Badge Format:
    Pullpo's alert for a pull request approval.

You can toggle between these formats in the Settings.

💡 Tips & Best Practices

  1. Be Specific: Use clear, actionable language
  2. Use Appropriate Labels: Match the severity of your feedback
  3. Add Context: Include relevant code snippets or examples
  4. Be Professional: Keep comments constructive and helpful
  5. Use Decorators: Help authors prioritize their responses

Need to customize the extension? Check out the Settings guide.

Previous
Installation
PRODUCT
COMPANY
LEGAL
Terms
Privacy policy
PULLPO
© All rights reserved.