|
| 1 | +# Getting Started with Copilot Workspace |
| 2 | + |
| 3 | +Welcome to the technical preview for Copilot Workspace! 👋 In order to help you get started, here are a few potential things you can try out: |
| 4 | + |
| 5 | +1. __Open an issue in a GitHub repo, and click the “Open in Workspace” button.__ This will start a new Copilot Workspace |
| 6 | + session, pre-seeded with the issue as the task, and allow you to iterate on the spec/plan/implementation for it |
| 7 | + |
| 8 | + <img src="images/open-in-workspace.png" width=800 alt="Open an issue in Copilot Workspace"> |
| 9 | + |
| 10 | +1. __Open the integrated terminal__ in order to build/test/run your changes. You can do this by clicking the terminal icon |
| 11 | + in the header bar, or clicking the “Open terminal” button in the “Implementation” panel (after you’ve started |
| 12 | + implementing a task). |
| 13 | + |
| 14 | +1. __Share a workspace with someone__ by clicking the share button in the upper-right section of the header bar, and |
| 15 | + sending them the URL. Note that at the moment, this only works for other people that are in the preview. For the actual |
| 16 | + tech preview launch, anyone will be able to view a read-only version of a shared session, as long as they have access to |
| 17 | + the repo. |
| 18 | + |
| 19 | +1. __Install the GitHub mobile app__ on your phone and open an issue from there by clicking the “...” menu and selecting |
| 20 | + “Open in Workspace”. Note that the mobile web client for Copilot Workspace is optimized for mobile usage. And since your |
| 21 | + sessions/edits are automatically saved, you can start a task on your phone and resume it on your desktop. |
| 22 | + |
| 23 | +1. Visit the [Copilot Workspace dashboard](https://copilot-workspace.githubnext.com) and __start a new session__ by |
| 24 | + clicking the “New Session” button. This will allow you to search for a repo and then define an ad-hoc task for it. |
| 25 | + Effectively like a draft issue. And if you select a [template repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository), you can define the requirements of a new repo that |
| 26 | + you create from that. |
| 27 | + |
| 28 | + <img src="images/dashboard.png" width=800 alt="Open an issue in Copilot Workspace"> |
| 29 | + |
| 30 | +1. __Iterate on a pull request__ by clicking the “Open in Workspace” button, defining the change you’d like to make (e.g. |
| 31 | + “Add docs for the changes in the PR”) and then implementing them. |
| 32 | + |
| 33 | + <img src="images/pr.png" width=800 alt="Open an issue in Copilot Workspace"> |
| 34 | + |
| 35 | +1. __Open a workspace session in a Codespace,__ by clicking the “Open in Codespace” button in the header bar or in the |
| 36 | + “Implementation” panel. Note that your workspace edits will be synced to the Codespace, and also, any edits you make in |
| 37 | + the Codespace are synced back to the workspace. This allows you to use VS Code/Codespaces as a companion experience for |
| 38 | + making larger edits, debugging, etc. |
0 commit comments