Review and manage your GitHub pull requests and issues directly in VS Code
This extension allows you to review and manage GitHub pull requests and issues in Visual Studio Code. The support includes:
- Authenticating and connecting VS Code to GitHub and GitHub Enterprise.
- Listing and browsing PRs from within VS Code.
- Reviewing PRs from within VS Code with in-editor commenting.
- Validating PRs from within VS Code with easy checkouts.
- Terminal integration that enables UI and CLIs to co-exist.
- Listing and browsing issues from within VS Code.
- Hover cards for "@" mentioned users and for issues.
- Completion suggestions for users and issues.
- A "Start working on issue" action which can create a branch for you.
- Code actions to create issues from "todo" comments.
It's easy to get started with GitHub Pull Requests for Visual Studio Code. Simply follow these steps to get started.
- Install the extension from within VS Code or download it from the marketplace.
- Open your desired GitHub repository in VS Code.
- A new viewlet will appear on the activity bar which shows a list of pull requests and issues.
- Use the button on the viewlet to sign in to GitHub.
- You may need to configure the
githubPullRequests.remotessetting, by default the extension will look for PRs fororiginandupstream. If you have different remotes, add them to the remotes list. - You should be good to go!
Check out https://www.youtube.com/watch?v=LdSwWxVzUpo for additional getting started tips!
There are several settings that can be used to configure the extension.
VS Code 1.141 or later is required. If you use Insiders, keep it updated to the latest build.
Configure GHE.com and GitHub Enterprise Server instances using the built-in GitHub Authentication setting:
{
"github-enterprise.uris": [
"https://company.ghe.com",
"https://github.example.com"
]
}The list order does not select a default instance. An explicitly configured list takes precedence over the deprecated github-enterprise.uri setting, including an empty list ([]), which disables Enterprise instances. If the list is not configured, the legacy setting still applies. Workspace and folder instance settings only apply in trusted workspaces.
GitHub Pull Requests uses one selected Enterprise account at a time, alongside a separate GitHub.com account. When another instance is needed or no account is selected, use Select Account in the Pull Requests or Login view. This opens account preferences for this extension and GitHub Enterprise directly, or starts sign-in if you have no Enterprise accounts yet. You can also run GitHub Pull Requests: Select GitHub Enterprise Account... or use Accounts > Manage Extension Account Preferences.... To add another instance, edit github-enterprise.uris in Settings; ordinary sign-in does not replace your existing list.
Removing an instance from the list does not delete its saved sign-ins. GitHub.com accounts do not need either Enterprise setting.
As mentioned above, githubPullRequests.remotes is used to specify what remotes the extension should try to fetch pull requests from.
To customize the pull request tree, you can use the githubPullRequests.queries setting. This setting is a list of labels and search queries which populate the categories of the tree. By default, these queries are "Waiting For My Review", "Assigned To Me", and "Created By Me". An example of adding a "Mentioned Me" category is to change the setting to the following:
"githubPullRequests.queries": [
{
"label": "Waiting For My Review",
"query": "is:open review-requested:${user}"
},
{
"label": "Assigned To Me",
"query": "is:open assignee:${user}"
},
{
"label": "Created By Me",
"query": "is:open author:${user}"
},
{
"label": "Mentioned Me",
"query": "is:open mentions:${user}"
}
]
Similarly, there is a setting to configure your issues queries: githubIssues.queries.
Queries use GitHub search syntax.
To view additional settings for the extension, you can open VS Code settings and search for "github pull requests".
This extension is still in development, so please refer to our issue tracker for known issues, and please contribute with additional information if you encounter an issue yourself.
See our wiki for our FAQ.
If you're interested in contributing, or want to explore the source code of this extension yourself, see our contributing guide, which includes: