Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds wsl install note to CONTRIBUTING.md #4618

Merged
merged 2 commits into from
Aug 30, 2024

Conversation

isaiah3031
Copy link
Contributor

@isaiah3031 isaiah3031 commented Aug 29, 2024

Read comments, before committing pull request read checklist again

Checklist:

  • I have performed a self-review of my own code,

  • I have commented my code, particularly in hard-to-understand areas,

  • I have made corresponding changes to the documentation,

  • I have added tests that prove my fix is effective or that my feature works,

  • New and existing unit tests pass locally with my changes ("bundle exec rake"),

  • Title include "WIP" if work is in progress.

Description

Guide questions:

  • What motivated this change (if not already described in an issue)?
    There was a request for a way to run Linux on a windows machine in the CONTRIBUTING.md file
  • What alternative solutions did you consider?
    WSL-2 is a "lightweight utility virtual machine (VM)". An alternative would be running an actual virtual machine or using a docker container.
  • What are the tradeoffs for your solution?
    Lacks the full features of Linux and can be less performant.
    List any dependencies that are required for this change. (gems, js libraries, etc.)

Include anything else we should know about.

Type of change

  • Documentation update

@awwaiid
Copy link
Collaborator

awwaiid commented Aug 30, 2024

@isaiah3031 ... and it worked like magic with basically default WSL+Ubuntu?

@isaiah3031
Copy link
Contributor Author

@isaiah3031 ... and it worked like magic with basically default WSL+Ubuntu?

@awwaiid Yeah after you install wsl and continue with the install steps in CONTRIBUTING everything runs. I've been working on a team of ruby developers for the past threeish years and we all start on windows machines using wsl2. I think there are some edge cases where other tools would be more useful but I can run Human Essentials comfortably with this setup.

Copy link
Collaborator

@awwaiid awwaiid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes -- I've helped people use this setup too in the past, so good that it is still the best way. Thank you for the update!

@awwaiid awwaiid merged commit d4ed1c9 into rubyforgood:main Aug 30, 2024
1 check passed
Copy link
Contributor

github-actions bot commented Sep 1, 2024

@isaiah3031: Your PR Adds wsl install note to CONTRIBUTING.md is part of today's Human Essentials production release: 2024.09.01.
Thank you very much for your contribution!

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