Include NVDA-VSCode as a Submodule#17211
Merged
Merged
Conversation
…irectory being dirty should be ignored
seanbudd
reviewed
Sep 25, 2024
Co-authored-by: Sean Budd <sean@nvaccess.org>
…to vscodeSubmodule
seanbudd
approved these changes
Sep 25, 2024
This file contains hidden or 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
2 participants
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.
Link to issue number:
Closes #17003
Summary of the issue:
The nvda-vscode repository exists to create a workspace configuration for VS Code that contains some sensible defaults, and recommendations for extensions that make developing for NVDA to our standards easier. However, using this workspace configuration currently requires manually clone it.
Description of user facing changes
None
Description of developer-facing changes:
The
.vscodedirectory for NVDA is now included as a submodule. This reduces friction for VS Code users, should have effectively no impact on users of other IDEs, and can be disabled by users who do not desire this behaviour.Description of development approach
Added nvaccess/vscode-nvda as a submodule. Set its
ignoreoption todirtyso that users' changes to their project config don't cause the superproject to show as dirty. Updated the dev docs to note the change.Testing strategy:
Verified that
.gitmoduleshas been updated.Known issues with pull request:
None.
Note
This should be merged after merging nvaccess/vscode-nvda#17 and checking out the new head of nvaccess/vscode-nvda.
Code Review Checklist:
@coderabbitai summary