-
Notifications
You must be signed in to change notification settings - Fork 17
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
chore: add contribution documentation for contributors on Windows machines #17
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this PR. This is very worthy.
I am not a Windows user so I can't verify the behavior, but this is probably good. I made very minor comments, I hope you can see it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I commented again, I was trying to follow markdown conventions and make it more readable.
Thanks @go-to-k! I applied the changes and resolved the conversations. Also added a small Note to direct users to keep the project in the WSL file system and not the "mounted" Windows |
Also @go-to-k I see the PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes. Nice adding. I also added last minor comments, again.
Also @go-to-k I see the PR docs: is not supported in the validate PR title
Oh, I see. I'll change the PR title!
Co-authored-by: k.goto <[email protected]> Signed-off-by: Estian Yssel <[email protected]>
Co-authored-by: k.goto <[email protected]> Signed-off-by: Estian Yssel <[email protected]>
Thanks updated as requested! I think it may now make sense to add a general "setup" section for Linux/Mac users? If so we can create a separate issue for this :) |
Added the last comment. : #17 (comment)
That's good! It's helpful! |
Co-authored-by: k.goto <[email protected]> Signed-off-by: Estian Yssel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for your contribution @EYssel !
Looking forward to the another issue for Linux/Mac users.
Adds to the
CONTRIBUTING.md
to help contributors on Windows machines with the setup process.The setup requires extra non-obvious steps, such as using WSL, which merits some documentation.