This extension allows you to create a code review file you can hand over to a customer.
create review notes
Simply right click somewhere in the opened file and choose the option "Code Review: Add Note".
You will be prompted for your note you wanna add.
The result will look like this:
The line column indicates an array of selected ranges or cursor positions separated by a
export created notes as HTML
Once you finished your review and added your notes, you can export the results as an HTML report. Therefore open the VSCode Command Palette (macOS: ⇧+⌘+P, others: ⇧+Ctrl+P) and search for "Code Review":
When you choose to generate the report using the default template, it will look like this in the end:
Custom handlebars template
You can also choose to export the HTML report by using a custom Handlebars template.
One you choose this option you cot prompted to choose the template file (file extension must be either
The used structure to fill the template placholders is an array of
Check out the example template file
Export for Issue Tracking System
export created notes as GitLab importable CSV file
Once you finished your code review, you can export the results to a formatted csv file that's importable into Gitlab issues.
Once exported, you can import the file in the GitLab project
export created notes as GitHub importable CSV file
You can export the code review results to a formatted csv file that's importable into GitHub by using
export created notes as JIRA importable CSV file
You can also export the notes as a CSV file to import them into your JIRA issue tracking system.
After exporting, you can import the file in your JIRA instance and probably map the props / ignore what you don't need:
The following settings can be adjusted via the configuration file
To easily add a new comment, you can use the keybinding combination
The review approach
If you got a customer request for doing a code review you will ideally receive read access to it's github / gitlab repoistory or similar. To create a code review with a report you should install this extension and go on with the following steps: