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

Documentation to help windows contributors #2841

Merged
merged 2 commits into from
Jan 9, 2018

Conversation

Dubes
Copy link
Contributor

@Dubes Dubes commented Jul 23, 2017

This PR is in follow up to the discussion in issue #2828

This introduces a new section in contributing.md for developers using windows machine to help them contribute to this project without relying on workarounds.

Tests:
Below are the screenshot that shows that the steps followed enable devs to use the scripts in the repo as is:

Running Prettier
This shows that windows bash is able to understand unix based paths and patterns without any changes.
image

Running .sh scripts in tasks folder
This shows that windows bash is able to run the scripts out of the box.
image

@facebook-github-bot
Copy link

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@cr101
Copy link
Contributor

cr101 commented Jul 23, 2017

It would be much easier if this PR #2280 was merged

@Dubes
Copy link
Contributor Author

Dubes commented Jul 24, 2017

@cr101 if that was the only file which caused issue, I would see both these PRs as an either or.
But I faced problems with prettier, running e2e tests etc., so I would see these two PRs as complimentary to each other.

#2280 --> First step of possibly many to enable cross platform development.
This PR as an immediate enabler for windows dev without putting an undue burden on either the devs or the community. From what I read about the windows subsystem for Linux, this kind of use case was the reason they provided that functionality in the first place.

@ianschmitz
Copy link
Contributor

I started an aggregated issue over at #2855 to help us suggest and track improvements for Windows based contributors. Cheers!

@gaearon
Copy link
Contributor

gaearon commented Jan 9, 2018

I just merged #2309. Will merge this too now but let me know if any info is outdated.

@Dubes
Copy link
Contributor Author

Dubes commented Jan 17, 2018

Thanks for merging it! To the best of my knowledge, the info is still valid. I just got a vanilla machine and will test the steps, will correct them if needed.

@Dubes Dubes deleted the DocumentationForWindowsContributors branch January 17, 2018 14:06
@gaearon
Copy link
Contributor

gaearon commented Jan 17, 2018

Amazing, thanks! Please test on the next branch since it's the one where we do active development now.

Pavek pushed a commit to Pavek/create-react-app that referenced this pull request Jul 10, 2018
* Added documentation for contributors using windows 10

Hopefully encourages devs on Windows machine to contribute

* corrected the wordings a little
@lock lock bot locked and limited conversation to collaborators Jan 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants