Reviewing a pull request
Open the link the author shared, or any pull request at https://logikflow.yemzikk.in/r/<owner>/<repo>/pull/<number>, and sign in with GitHub.
Read in order
The toolbar says whose order you're looking at and when it was saved, for example Reading order by octo · 2 hours ago. Read top to bottom:
- Sections start with a title, a note from the author, and sometimes a checklist.
- File cards show the diff, with the author's note and checklist above it when there is one.
- The file tree on the left follows the same order and highlights the file you're reading. Type in the filter box to find a file by path.
Diffs over 400 changed lines, and files the author labelled Generated, start collapsed. Open one with the arrow in its header. Collapse a whole section with the arrow next to its title. Each section shows how many of its files you've viewed.
Focus labels
Authors can label files so you know where to spend your attention:
| Label | Meaning |
|---|---|
| Key file | The heart of the change. Read it carefully. |
| Skim | Mechanical or low-risk, such as a rename or a string. |
| Generated | Generated or vendored output. Collapsed by default. |
Comments
A speech-bubble count in a file's header, and in the file tree, shows how many review comments the file has on GitHub. Click it, or the GitHub icon, to open that file's diff on GitHub.
View settings
The gear button in the toolbar holds the diff settings. Your choices are remembered in this browser.
- Unified (one column) or Split (old and new side by side).
- Hide whitespace: hides lines whose only change is whitespace, such as indentation.
- Compact line height: fits more lines on screen.
- Expand all and Collapse all.
Changed lines also highlight the exact characters that changed.
Keyboard shortcuts
| Key | Action |
|---|---|
j / k | Next or previous file |
n | Next file you haven't viewed |
v | Mark the current file viewed and go to the next one |
e | Expand or collapse the current file |
o | Open the current file in GitHub |
s | Switch between unified and split |
? | Show all shortcuts |
Viewed
Tick Viewed on a file when you're done with it. The card collapses and the file tree shows a check.
- Viewed is saved to your account, so it follows you to other devices and browsers.
- It's tied to the file's content. If the author pushes a change to that file, it becomes unviewed again, so you never miss a change.
- When that happens, the file shows Changed since you viewed. Choose it to see only what changed since you last looked, instead of the whole diff again. Choose Show full diff to switch back.
- Clear viewed unticks every file in the pull request at once, for when you want to start the review again.
The meter in the toolbar shows how many files you've viewed. The people button next to it shows everyone's progress: files viewed and checklist items ticked.
Checklists
Tick checklist items as you verify them. Your ticks are saved and shown to everyone: each item lists who checked it, and each section shows how many you've checked. Untick an item to take your check back.
Comments and approval
Leave review comments and approvals on GitHub as usual; Open on GitHub takes you there. LogiKFlow is for reading the change in the right order. It doesn't replace GitHub's review tools.
Refresh
Refresh reloads the pull request from GitHub, including new commits and the latest saved order.