vim-code-review

Code review from the comfort of my favorite editor.

As a software engineer, I spend a good chunk of my time reviewing my coworkers’ code. I enjoy code review, but the existing tools aren’t always my favorite. Why stare at diffs in the browser when I could be viewing them in my editor, where I can easily jump between files, inspect types, run tests, and more?

This (Neo)Vim plugin aims to create a convenient code review experience within the editor. Here’s my typical workflow:

1. Use git to checkout the branch that I want to review.

2. Open Vim and run :ReviewStart to begin.

3. Use the newly opened quickfix list to jump to files that need to be reviewed.

4. Use :ReviewDiffSplit to view a side-by-side diff of the branch and its merge destination. (The diff split auto-updates when I change to another file.)

5. Use :ReviewComment to write comments about the change in the review file.

6. When finished, use :ReviewPostGithub <PR url> to create a pending review with my comments on GitHub, which I can then double check and submit using the GitHub web UI.

(The plugin can currently only post to GitHub because that’s what I use for work. Contributions for posting to other forges are welcome! You can also send the review file to the author or copy/paste the comments into your code review system.)