Add Windows development setup guide for first-time contributors - #1112
Conversation
|
Hi @aman-dev-maker, thank you. You will need to update the README as well for your setup guide to show. |
…-maker/malariagen-data-python into fix/deprecation-warning # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
Hi Jon, Thank you for the feedback. I have updated the README Please do let me know if there is anything else that Best regards, |
|
Hi Jon, I have updated the WINDOWS_SETUP.md file |
|
Hi Jon, thank you so much for merging the PR |
While setting up the project for the first time on Windows,
I noticed there were setup guides for Linux and macOS but
nothing for Windows. I ended up spending a lot of time
figuring things out through trial and error, so I thought
it would be helpful to document the steps for other Windows
users who come after me.
I added a WINDOWS_SETUP.md file in the root folder that
walks through the full setup process step by step.
A few Windows specific things that caught me off guard while
setting up:
The default branch here is master not main
Python needs to be added to PATH manually during installation
PowerShell commands work a bit differently than bash
I also added a common issues section at the bottom based on
the actual errors I ran into personally, so future contributors
don't have to go through the same confusion.
Happy to make any changes based on your feedback!