Reviewing with Automation Tools
Last updated
Last updated
PullRequest runs builds to scan customer code for issues. We currently support Python, Go, PHP, Javascript, Typescript, Ruby and Swift. All supported pull requests will automatically populate potential violations in the diff view of the PullRequest platform.
Violations are displayed inline in the reviewer app.
As a reviewer, leverage these outputs as an additional guide for providing useful feedback to the developer. We rely on reviewers to confirm violations and filter out false-positives that serve no utility to the code author. Use your best judgement to determine important and actionable violations. Convert violations into a comment with your recommendations for remediation. Violations are not visible to the development team until they are converted to a comment and submitted with the review.
As there could be multiple similar violations in the PR, we recommend that you scan through the entire review before selecting and converting useful violations to comments.
Here is an example of a useful violation with meaningful reviewer feedback:
Note that some violations can be noisy and don't provide useful feedback for the developer. Hide noisy rules easily by clicking the slider. The slider hides (collapses) all similar violations from the diff view. You can toggle them back on from the settings menu or uncollapse individual violations by clicking the magnifying glass icon next to a line number.
You can also collapse/expand individual rules by clicking the arrow icons at the top left corner of the console output.
These automation tools have been added to the platform to help PullRequest reviewers catch important issues and provide expert recommendations customers can act on. Remember to always use your best judgement when converting violations to comments.
We will slowly be rolling out support for more languages and features. Stay tuned.
We welcome your suggestions, questions, and feedback! Feel free to reach out directly to a PullRequest team member on Slack.
