From 71243775241883f79659dc7b3a020182dd7aa445 Mon Sep 17 00:00:00 2001 From: Luis Valencia Date: Sat, 29 Jul 2023 00:09:42 +0200 Subject: [PATCH] Devcontainer README -> Clarification. (#8414) - Description: The contribution guidlelines using devcontainer refer to the main repo and not the forked repo. We should create our changes in our own forked repo, not on langchain/main - Issue: Just documentation - Dependencies: N/A, - Tag maintainer: @baskaryan - Twitter handle: @levalencia --- .devcontainer/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index fca59d84925..9bdd5bf5711 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -15,7 +15,11 @@ You may use the button above, or follow these steps to open this repo in a Codes For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace). ## VS Code Dev Containers -[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/hwchase17/langchain) +[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/langchain-ai/langchain) + +Note: If you click this link you will open the main repo and not your local cloned repo, you can use this link and replace with your username and cloned repo name: +https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com// + If you already have VS Code and Docker installed, you can use the button above to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. @@ -25,7 +29,7 @@ You can also follow these steps to open this repo in a container using the VS Co 2. Open a locally cloned copy of the code: - - Clone this repository to your local filesystem. + - Fork and Clone this repository to your local filesystem. - Press F1 and select the **Dev Containers: Open Folder in Container...** command. - Select the cloned copy of this folder, wait for the container to start, and try things out!