microsoft / vscode-remote-repositories-github

Quickly browse, search, edit, and commit to any GitHub or Azure Repos repository directly from within Visual Studio Code.
Creative Commons Attribution 4.0 International
206 stars 110 forks source link

Remote Repositories

This repository is for providing feedback on the GitHub Repositories and Azure Repos extensions. You can use the repository to report issues or submit feature requests.

The GitHub Repositories extension lets you quickly browse, search, edit, and commit to any remote GitHub repository directly from within Visual Studio Code. The Azure Repos extension lets you quickly browse, search, edit, and commit to any remote Azure Repos (part of Azure DevOps) repository directly from within Visual Studio Code.

Why Remote Repositories?

As developers, we often clone Git repos locally just to browse them or make small edits. We may want to look at the source code of a library we use, experiment with new tools, or just feel the desire to learn something new.

However, cloning repos takes time and maintenance, as your local copy can quickly become out of date if you don't pull changes regularly. Plus, if you don't know the codebase you're cloning, there may be security risks involved too!

The GitHub Repositories and Azure Repos extensions in VS Code give you a fast, convenient, and safe way to open, browse, and edit repos quickly.

Here are some great situations in which you may choose to use GitHub Repositories or Azure Repos to work on a codebase:

Features

This extension provides the following support for GitHub and Azure Repos repositories:

Integration with vscode.dev

GitHub Repositories and Azure Repos are built into vscode.dev so that you can easily use them right from your browser.

You can use the GitHub Repositories and Azure Repos extensions directly in your browser in the following ways:

GitHub Repositories URLs have the following structure:

https://vscode.dev/github/<owner>/<repo>

Azure Repos URLs have the following structure:

https://vscode.dev/azurerepos/<organization>/<project>/<repo>

Continue Working On...

When working with either GitHub or Azure repositories, you have several options to continue working in a more powerful environment.

Releases

While an optional install, this extension releases along with VS Code. The VS Code release notes will include a summary of changes.

You can also install the pre-release version of this extension for early feedback and testing. The pre-release version of this extension works best in VS Code Insiders. You can learn more about VS Code's support for pre-release extensions here.

The pre-release version of this extension replaces the GitHub Repositories (Insiders) extension, which is now deprecated. If you are still using the GitHub Repositories (Insiders) extension and want to migrate to pre-releases,

  1. Commit any uncommitted changes in your existing GitHub Repositories workspaces to retain access to them after you uninstall the extension.
  2. Uninstall the GitHub Repositories (Insiders) extension.
  3. Install the pre-release edition of the GitHub Repositories extension.

Providing Feedback

You can use this repository to:

If you have a question, connect with the community using any of these social platforms:

Twitter Stack Overflow VS Code Dev Community Slack VS CodeGitter

License

By downloading and using the GitHub Repositories extension and its related components, you agree to the product license terms and privacy statement.

License for this repository:

Copyright © Microsoft Corporation All rights reserved. Creative Commons Attribution 4.0 License (International): https://creativecommons.org/licenses/by/4.0/legalcode. For any code or snippets within this repository itself: https://github.com/microsoft/vscode-remote-repositories-github/blob/main/LICENSE-CODE.