Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 3ff2069

Browse files
committed
Add about and use VSCode files
1 parent 6fdc21b commit 3ff2069

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

docs/guides/about-vscode.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Overview
3+
description: How to review your code with the VSCode extension.
4+
---
5+
6+
This page is about the CodeRabbit VSCode extension. For a broader overview of CodeRabbit, see [Introduction](/overview/introduction).
7+
8+
## About the VSCode extension
9+
10+
The CodeRabbit VSCode extension lets you apply a limited subset of CodeRabbit’s code-review features to your local development environment, directly from the VSCode IDE.
11+
12+
## Features
13+
14+
The extension includes the following features:
15+
16+
- Automatic reviews of local Git commmits
17+
18+
- Manually requested reviews of local code changes
19+
20+
## Price and limitations
21+
22+
This extension is free to install and use, and works with any tier of CodeRabbit account. You can use the extension on its own, or you can use it to complement your local development on a repository whose remote has CodeRabbit installed.
23+
24+
Rate limits apply to the numnber of local reviews that you can request per hour.
25+
26+
## What's next
27+
28+
- [Install the VSCode extension](/guides/install-extension)
29+
30+
- [Use the VSCode extension](/guides/use-extension)

docs/guides/use-vscode.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Use the VSCode extension
3+
description: How to review your code with the VSCode extension.
4+
---
5+
6+
This page is about using the CodeRabbit VSCode extension. For more information about the extension, see
7+
[Overview](/guides/about-vscode). To learn how to install the extension, see [Install the VSCode extension](/guides/install-vscode).
8+
9+
## Review your code changes
10+
11+
To manually review changes in a local Git branch using the CodeRabbit VSCode extension, follow these steps:
12+
13+
1. Click the CodeRabbit icon in the VSCode activity bar. The CodeRabbit sidebar appears.
14+
15+
1. Refer to **Branch** in the CodeRabbit sidebar. If you want to compare your code changes
16+
to a branch other than the default that appears, then follow these steps:
17+
18+
1. Click the name of the base branch, which is `main` by default. A **Select a base branch** dialog appears, listing other branches in your local Git repository.
19+
20+
1. Select the name of a base branch to compare against.
21+
22+
1. Select one of the review-action options from the menu at the bottom of the CodeRabbit sidebar:
23+
24+
- To review all changes between the base branch and your current branch, including
25+
both committed and uncommitted changes, select **Review all changes**. This is the default selection.
26+
27+
- To limit the review to only changes on your branch that you have committed, select **Review committed changes**. This includes both pushed and not-pushed commits on the current branch.
28+
29+
- To limit the review to only uncommitted changes on your branch, select **Review all changes**.
30+
31+
1. Refer to the list of **Files to review** in the sidebar. This list represents all of the files that the selected review style includes. To change this list of files, repeat the previous step to choose a different review style, or use Git features like `git stash` to remove changes to files.
32+
33+
1. To perform the review, click the button part of the menu. The CodeRabbit sidebar displays a **Review** section with the review's progress.
34+
35+
1. Wait for the review to complete. This might take several minutes. To cancel a review in progress, click **Stop the review**.
36+
37+
## What's next
38+
39+
- The CodeRabbit [Introduction](/overview/introduction) describes how you can complement the CodeRabbit VSCode extension by setting up automatic, full-featured code reviews on your remote repository's pull requests.

0 commit comments

Comments
 (0)