[751] feat: add dev environment setup instructions for Windows users #775
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.
title: Issue #751 | Add dev environment setup instructions for Windows users
Discord Username: @buunny9092
What type of PR is this? (select all that apply)
Description
This PR updates the
CONTRIBUTING.mdfile with detailed instructions for setting up the development environment on Windows. It includes step-by-step guidance on installing Docker, setting up WSL (Windows Subsystem for Linux), and configuring the necessary environment variables. The goal is to help Windows users quickly set up the dev environment, ensuring smooth onboarding for those who wish to contribute to the project.Related Tickets & Documents
QA Instructions, Screenshots, Recordings
To test this change, follow the updated instructions in the
CONTRIBUTING.mdfile for setting up the development environment on Windows. Verify that the Docker containers run correctly on a fresh Windows setup, and that both the app and web socket server start without issues. The steps should also be verified using WSL.UI accessibility concerns?
N/A - This change only affects the documentation and does not modify the UI.
Added/updated tests?
[optional] Are there any post deployment tasks we need to perform?
N/A
[optional] What gif best describes this PR or how it makes you feel?