[DOC] Add WSL setup guide and setup script for Windows contributors#531
Open
direkkakkar319-ops wants to merge 5 commits intosktime:mainfrom
Open
[DOC] Add WSL setup guide and setup script for Windows contributors#531direkkakkar319-ops wants to merge 5 commits intosktime:mainfrom
direkkakkar319-ops wants to merge 5 commits intosktime:mainfrom
Conversation
Author
|
Hi, @fkiraly I have raised this PR to add a WSL setup guide for Windows contributors since skbase currently has no Windows development docs. Includes both the RST documentation page and the |
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
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.
Reference Issues/PRs
No existing issue — proactive documentation improvement for Windows contributors.
What does this implement/fix? Explain your changes.
skbase currently has no documentation for Windows users who want to
contribute using WSL (Windows Subsystem for Linux). This PR adds both
the documentation page and the automated setup script.
Two files added:
docs/source/contribute/development/wsl_setup.rstscripts/setup_wsl.shDoes your contribution introduce a new dependency? If yes, which one?
No new dependencies introduced. Documentation and shell script only.
What should a reviewer concentrate their feedback on?
docs/source/contribute/development/the right location forthe RST page?
.venv_wslthe right name for the virtual environment or shouldit follow an existing convention in the project?
Any other comments?
This guide is aimed at Windows contributors who are new to open source
and may not know how to set up a Linux-like development environment.
Since skbase has no Windows development guide currently, this lowers
the barrier to entry for a large group of potential contributors.
The shell script uses
set -eto exit immediately on any error,and safely skips virtual environment creation if
.venv_wslalreadyexists to make it safe to re-run.
Tested on Ubuntu WSL — all tests pass after running
scripts/setup_wsl.sh.Screenshot attached below:
PR checklist
For all contributions
the PR topic is related to enhancement, CI/CD, maintenance, documentation, or a bug.
For code contributions