Adding review highlight and listing review #244
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview:
This pull request introduces enhancements to the REVIEW annotation features within our VSCode extension. The primary goal is to improve the visibility and management of REVIEW tags in the codebase, facilitating easier and more effective code reviews.
Motivation:
Following our discussion in issue #243 and feedback from several team members, it became evident that our current handling of REVIEW annotations was insufficient for the needs of our large-scale projects. These changes aim to address this gap and align with our goals for maintaining high code quality.
Changes Made:
Highlighting REVIEW Annotations: Added distinct purple background color and overview ruler markings for REVIEW annotations.
Listing Annotations Command: Implemented a new command to list all REVIEW annotations across the project, enhancing navigability.
User Configuration Options: Introduced settings allowing users to customize the appearance and behavior of REVIEW annotation highlights.
How to Test the Changes:
Checkout the branch feature/review-enhancements.
Open any project with existing REVIEW annotations.
Go to settings and ensure the "Highlight REVIEW Annotations" feature is turned on.
Verify that REVIEW annotations are highlighted as specified, and use the "List REVIEW Annotations" command from the command palette.
Additional Notes:
These changes are designed to be backward compatible with existing settings. However, extensive testing in different environments
Code_3oz0I31dec.mp4
Code_OxyBrowSJw.mp4
Request for Feedback:
I would appreciate feedback on the UI changes, especially the color choices and the visibility of the annotation list in varied lighting conditions. Any suggestions for further improvement or potential issues are also welcome.