Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance PR review experience in Copilot Workspace #91

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ To begin using the new `Commands` hub, simply click the existing terminal icon i

Additionally, if you've configured a `build`, `test`, or `launch` task in your `devcontainer.json`, then you can click to run any of those. This will result in the command being displayed in the list on the `Output` tab, and allow you to view its output, stop it, or re-run it once complete (e.g. to re-trigger a build after editing code).

<img src="https://github.com/user-attachments/assets/6a0f0ecc-64f0-4871-b5f3-0840c684b85e" width="450px" />
<img src="https://github.com/user-attachments/assets/6a0f0ecc-64f0-4871-b5f3-0840c684b85c" width="450px" />

And just like the existing terminal, if a build/test/run command starts a server, then it will be automatically forwarded, so you can securely view it.

Expand Down Expand Up @@ -1174,3 +1174,15 @@ For example, here's a [sample session](https://copilot-workspace-staging.githubn
## 📅 29 April 2024

Initial release! 🚀

## 📅 15 December 2024

We are excited to announce several new enhancements to the PR review experience in Copilot Workspace! These updates aim to improve the overall user experience by allowing you to view and respond to individual comments and synchronize selected suggestions with the exact part of the file to be modified.

### PR Review Enhancements

- **View and Respond to Individual Comments:** You can now view and respond to individual comments within the PR review experience. This makes it easier to address all feedback and ensure that no comments are missed.
- **Synchronize Selected Suggestions:** The UI now synchronizes the selected suggestion with the exact part of the file to be modified. This ensures that the correct changes are applied and helps you verify that nothing else was altered.

These enhancements are designed to streamline the PR review process and make it more efficient. We hope you find them useful and look forward to your feedback!

4 changes: 4 additions & 0 deletions known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,8 @@ The repair flow from the terminal to the plan sometimes times out, causing the t
A workaround for this is to click the send button (up arrow icon) again can regenerate the suggestion.
We understand that this is not ideal, and are working on a solution to this issue.

### PR review enhancements

The new PR review enhancements in Copilot Workspace allow users to view and respond to individual comments and synchronize selected suggestions with the exact part of the file to be modified. However, there are some known issues related to these enhancements:

- Potential performance impacts when loading large PRs with many comments. We are working on optimizing the performance to handle large PRs more efficiently.
19 changes: 19 additions & 0 deletions repo-maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,30 @@ Copilot Workspace can assist you as a repository maintainer in several ways:
1. Copilot Workspace can help you explore potential solutions to issues.
2. Copilot Workspace can help you generate sketches of solutions to issues for potential contributors, lowering the barrier of entry.
3. Copilot Workspace can help encourage a culture where issue-creators leave additional helpful notes on how to solve issues, for use by both contributors and AI assistants.
4. Copilot Workspace can enhance the PR review experience by allowing you to view and respond to individual comments and synchronize selected suggestions with the exact part of the file to be modified.

For example, when a new issue is filed in your repository, you can use Copilot Workspace to generate a sketch of a solution to the issue. You can then use the "Share" button to publish this sketch back to the issue thread, with additional comments about whether you think it is useful or not, and where it might need improvement. This can help potential contributors understand the problem better and provide a starting point for their work.

Similarly, when a new issue is filed, you can ask the contributor to create a Copilot Workspace session for the issue. This may help the contributor understand the problem better and provide a starting point for their work. You can also include this guidance in the issue template for your repository, assuming your users have access to Copilot Workspace. You can also ask contributors to leave additional notes in the Copilot Workspace session, which can help future contributors and AI assistants understand the problem better.

## Enhancing the PR Review Process

The new PR review enhancements in Copilot Workspace provide several benefits for repository maintainers:

1. **View and respond to individual comments**: You can now view all comments within a PR review, including those without suggested code. This allows you to address all feedback and respond to comments directly within the PR review experience.
2. **Synchronize selected suggestions with the exact part of the file to be modified**: The UI now synchronizes the selected suggestion with the exact part of the file to be modified, ensuring accurate application of changes.

### Using the New PR Review Features

To use the new PR review features in Copilot Workspace, follow these steps:

1. Open a PR review in Copilot Workspace.
2. Navigate through the individual comments using the new comment navigation feature.
3. Respond to comments directly within the PR review experience.
4. Apply selected suggestions and verify that the UI synchronizes with the exact part of the file to be modified.

These enhancements streamline the review process and help ensure that all feedback is addressed accurately.

## Restricting the use of Copilot Workspace in your repository

It is possible for undisciplined contributors to over-use AI-assisted code generation. Because of this, we give repository maintainers the option of disabling the direct use of Copilot Workspaces for creating pull requests and/or issue comments in their repositories.
Expand Down
4 changes: 4 additions & 0 deletions settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ When this setting is enabled, a Codespace will be automatically created when you
## Show notification after implementing

When this setting is enabled, Copilot Workspace will notify you when it has completed its implementation. This allows you to get back into the flow as soon as possible, without having to constantly check the status of the implementation. You can enable or disable this setting based on your preference.

## Enable PR review enhancements

When this setting is enabled, the PR review experience in Copilot Workspace will include the ability to view and respond to individual comments and synchronize selected suggestions with the exact part of the file to be modified. This enhances the overall review process and ensures accurate application of changes. You can enable or disable this setting based on your preference.
Loading