MenuGetting started

Getting started

Open a pull request in VS Code, read meaningful changes and follow review evidence to the code.

On this page

Before you start

Use VS Code and Git with access to the repository you want to review. Sign in to GitHub in VS Code when prompted.

Release availability

Oaink is being prepared for release. Installation details will appear here when the public package is available.

Check analysis availability

Oaink prepares local analysis when you open a review. If setup cannot complete, read the Oaink output for the next action. The local diagnostics command can help identify a setup issue.

sh
oaink doctor

Open a pull request

Run Oaink: Review Pull Request… in the Command Palette, then select a pull request. The Overview summarizes the change while deep static analysis results arrive.

Read the change map

Select a changed symbol to open the structural diff. Follow callers, diagnostics and test findings to their code. Mark symbols as reviewed as you read; unchanged symbols keep their reviewed marks across new pushes.