A browser extension that enhances code reviews by implementing the Conventional Comments standard directly in GitHub and GitLab interfaces.
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
Conventional Comments - by Pullpo brings the power of Conventional Comments directly into your GitHub and GitLab workflow. It adds a sleek, intuitive toolbar to every comment box, making it easy to:
- Add standardized labels to your comments (praise, suggestion, issue, etc.)
- Include decorators for additional context (non-blocking, blocking, if-minor)
- Maintain consistent formatting across all review comments
- Toggle between plain text and badge-style formatting
- 🎨 Intuitive Toolbar: Seamlessly integrated into GitHub and GitLab interfaces
- 🏷️ Standard Labels:
praise
: Highlight something positivenitpick
: Minor, non-blocking issuessuggestion
: Suggest specific improvementsissue
: Point out blocking problemsquestion
: Ask for clarificationthought
: Share a reflection or ideachore
: Request minor, non-code tasks
- 🎯 Decorations:
(non-blocking)
: Optional changes(blocking)
: Must be addressed(if-minor)
: Address if the effort is small
- 🔄 Toggle Functionality: Easily remove labels or decorations
- 🎨 Badge Style Option: Switch between text and visual badge formats
- 🌓 Dark Mode Support: Seamlessly works with both GitHub and GitLab themes
- Visit the Chrome Web Store
- Click "Add to Chrome"
- The extension will automatically activate on GitHub.com and GitLab.com
- Visit the Firefox Add-ons
- Click "Add to Firefox"
- The extension will automatically activate on GitHub.com and GitLab.com
- Navigate to any pull request or merge request on GitHub or GitLab
- Click on the comment box
- Use the toolbar that appears above the comment box:
- Select a label type (e.g., "suggestion", "issue")
- Optionally add a decoration
- Write your comment
- Your comment will be automatically formatted according to the Conventional Comments standard
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
The extension can be built for both Chrome and Firefox using our build system:
-
Clone the repository and install dependencies:
git clone https://github.com/pullpo/conventional-comments-helper.git cd conventional-comments-helper npm install
-
Build for your target browser:
- For Chrome:
npm run build:chrome
- For Firefox:
npm run build:firefox
- For both browsers:
npm run build
- For Chrome:
-
Load the extension:
- Chrome: Load the
build/chrome
directory as an unpacked extension - Firefox: Load the
build/firefox
directory as a temporary add-on
- Chrome: Load the
This project is licensed under the MIT License - see the LICENSE file for details.
- Inspired by conventionalcomments.org
- Built with love for the open source community