/vscode-pull-request-github

GitHub Pull Requests for Visual Studio Code

Primary LanguageTypeScriptMIT LicenseMIT


logo
GitHub Pull Requests

Review and manage your GitHub pull requests directly in VS Code

Marketplace bagde Marketplace Rating

This extension allows you to review and manage GitHub pull requests in Visual Studio Code. The support includes:

  • Authenticate and connect VS Code to GitHub
  • List and browse PRs from within VS Code
  • Review 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.

Demo

How to get started?

It's easy to get started with GitHub Pull Requests for Visual Studio Code. Simply follow these steps to get started.

  1. Make sure you have VSCode version 1.27.0 or higher
  2. Download the extension from the marketplace
  3. Reload VS Code after the installation (click the reload button next to the extension)
  4. Open your desired GitHub repo
  5. Go to the SCM Viewlet, and you should see the GitHub Pull Request treeview. On the first load, it will appear collapsed at the bottom of the viewlet.
  6. A notification should appear asking you to sign in GitHub, follow the directions to authenticate
  7. You should be good to go!

Extension

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.

Questions? Authentication? GitHub Enterprise?

See our wiki for our FAQ.

How to run from source?

If you want explore the source code of this extension yourself, it's easy to get started. Simply follow these steps:

  1. Clone the repository
  2. Run yarn
  3. Compile in the background
    • Run yarn watch
    • Or you can directly start this task by Command Palette -> Run Build Task
  4. F5, launch the extension in latest VS Code Insiders.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.