Pull Request Comments
Qlty can automatically add informative code coverage comments to your GitHub pull requests. These comments provide immediate visibility into how code changes affect your test coverage without leaving GitHub.
Benefits of PR Comments
- Immediate feedback: See file-level coverage information directly in your PR
- Increased visibility: Integrate coverage data into your PR comment threads
- Actionable insights: Identify files in the PR with low coverage that need attention
Example PR Comment
Here’s an example of a Qlty coverage comment on a pull request:
Enabling PR Comments
To enable pull request comments:
- Go to your project in Qlty
- Navigate to “Project Settings” > “Comments”
- Toggle “Summary Comments” on
Advanced Features
Comment Updates
Qlty automatically updates the PR comment when:
- New coverage data is uploaded for the PR
- The PR is updated with new commits
- Coverage metrics change due to new tests
This ensures the comment always shows the most current information.
Customizing Comment Templates
For organizations with specific needs, Qlty supports custom comment templates. Contact our support team to learn more about this enterprise feature.
Combining with Commit Statuses
For a complete quality gate system, combine PR comments with commit statuses:
- Commit statuses: Enforce coverage requirements before merging
- PR comments: Provide detailed information to help developers meet those requirements
This combination creates a powerful feedback loop that improves code quality and test coverage.
Troubleshooting
Comment Not Appearing
If you don’t see the PR comment:
- Ensure the Qlty GitHub App is installed on that specific repository
- Verify that a coverage report was successfully uploaded for the PR
- Check that PR summary comments are enabled in your project settings
Outdated Information
If the comment shows outdated information:
- Ensure your CI is uploading coverage reports for the latest commit
- Verify the correct commit SHA is being reported with the coverage data
See Also
- Commit Statuses - Configure GitHub commit statuses for code coverage
- CI Integration - Automate coverage reporting in your CI pipeline
- VS Code Extension - View coverage information directly in your editor