Skip to content

Add Windows development setup guide for first-time contributors - #1112

Merged
jonbrenas merged 9 commits into
malariagen:masterfrom
aman-dev-maker:fix/deprecation-warning
Mar 25, 2026
Merged

Add Windows development setup guide for first-time contributors#1112
jonbrenas merged 9 commits into
malariagen:masterfrom
aman-dev-maker:fix/deprecation-warning

Conversation

@aman-dev-maker

Copy link
Copy Markdown
Contributor

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!

@jonbrenas

Copy link
Copy Markdown
Collaborator

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.
@aman-dev-maker

Copy link
Copy Markdown
Contributor Author

Hi @aman-dev-maker, thank you. You will need to update the README as well for your setup guide to show.

Hi Jon,

Thank you for the feedback. I have updated the README
to include a link to the Windows setup guide so that
it appears alongside the existing Linux and macOS guides.

Please do let me know if there is anything else that
needs to be changed or improved.

Best regards,
Aman

@aman-dev-maker

Copy link
Copy Markdown
Contributor Author

Hi Jon, I have updated the WINDOWS_SETUP.md file
to fix the linting errors. The previous version had
a duplicate line and an incorrect URL which have both
been corrected. Please let me know if there is
anything else to address.

@jonbrenas
jonbrenas merged commit 10b360b into malariagen:master Mar 25, 2026
8 checks passed
@aman-dev-maker

Copy link
Copy Markdown
Contributor Author

Hi Jon, thank you so much for merging the PR
and for making improvements to the file.
I really appreciate your time and guidance
throughout this process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants