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.

Sign up for GitHub

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

Jump to bottom

chore: add contribution documentation for contributors on Windows machines #17

Merged
merged 8 commits into from
Apr 25, 2024
Merged

chore: add contribution documentation for contributors on Windows machines #17

merged 8 commits into from
Apr 25, 2024

Conversation

EYssel
Copy link
Contributor

@EYssel EYssel commented Apr 24, 2024

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.

@mbonig mbonig requested a review from go-to-k April 24, 2024 21:27
@go-to-k go-to-k changed the title chore: Adds contribution documentation for contributors on Windows Machines docs: add contribution documentation for contributors on Windows machines Apr 25, 2024
go-to-k
go-to-k requested changes Apr 25, 2024
View reviewed changes
Copy link
Contributor

@go-to-k go-to-k left a comment •
edited

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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
go-to-k
go-to-k requested changes Apr 25, 2024
View reviewed changes
Copy link
Contributor

@go-to-k go-to-k left a comment •
edited

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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@EYssel
Copy link
Contributor Author

EYssel commented Apr 25, 2024 •
edited

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 C:\ drive.

@EYssel EYssel requested a review from go-to-k April 25, 2024 09:27
@EYssel
Copy link
Contributor Author

EYssel commented Apr 25, 2024

Also @go-to-k I see the PR docs: is not supported in the validate PR title

go-to-k
go-to-k requested changes Apr 25, 2024
View reviewed changes
Copy link
Contributor

@go-to-k go-to-k left a comment •
edited

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!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@go-to-k go-to-k changed the title docs: add contribution documentation for contributors on Windows machines chore: add contribution documentation for contributors on Windows machines Apr 25, 2024
EYssel and others added 3 commits April 25, 2024 12:21
@EYssel @go-to-k
Update CONTRIBUTING.md
6d960ac 
Co-authored-by: k.goto <24818752+go-to-k@users.noreply.github.com>
Signed-off-by: Estian Yssel <38258302+EYssel@users.noreply.github.com>
@EYssel @go-to-k
Update CONTRIBUTING.md
6f17c01 
Co-authored-by: k.goto <24818752+go-to-k@users.noreply.github.com>
Signed-off-by: Estian Yssel <38258302+EYssel@users.noreply.github.com>
@EYssel
chore: fix typo in setup on WSL
a3b3074
@EYssel
Copy link
Contributor Author

EYssel commented Apr 25, 2024

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 :)

@EYssel EYssel requested a review from go-to-k April 25, 2024 10:26
@go-to-k
Copy link
Contributor

go-to-k commented Apr 25, 2024

Added the last comment. : #17 (comment)

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 :)

That's good! It's helpful!

@EYssel @go-to-k
chore: Use Node.js instead of Node
f39e9da 
Co-authored-by: k.goto <24818752+go-to-k@users.noreply.github.com>
Signed-off-by: Estian Yssel <38258302+EYssel@users.noreply.github.com>
go-to-k
go-to-k approved these changes Apr 25, 2024
View reviewed changes
Copy link
Contributor

@go-to-k go-to-k left a 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.

@go-to-k go-to-k added this pull request to the merge queue Apr 25, 2024
Merged via the queue into open-constructs:main with commit 2f27e8c Apr 25, 2024
5 checks passed
@EYssel EYssel mentioned this pull request May 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@go-to-k go-to-k go-to-k approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@EYssel @go-to-k