Skip to content

Documentation to help windows contributors #2841

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

Merged
merged 2 commits into from
Jan 9, 2018
Merged

Documentation to help windows contributors #2841

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1cc17d
Added documentation for contributors using windows 10
Dubes Jul 23, 2017
fd33fd8
corrected the wordings a little
Dubes Jul 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
corrected the wordings a little
  • Loading branch information
@Dubes
Dubes committed Jul 23, 2017
commit fd33fd8600c4c4c2e1d2f6a709e4da080c229e60
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ More detailed information are in the dedicated [README](/packages/react-scripts/

## Tips for contributors using Windows

The scripts in tasks folder and other scripts in `package.json` will not work in Windows out of the box. However, using [Bash on windows](https://msdn.microsoft.com/en-us/commandline/wsl/about) makes it easier to use those scripts without any workarounds.
The scripts in tasks folder and other scripts in `package.json` will not work in Windows out of the box. However, using [Bash on windows](https://msdn.microsoft.com/en-us/commandline/wsl/about) makes it easier to use those scripts without any workarounds. The steps to do so are detailed below:

### Install Bash on Ubuntu on Windows

Expand All @@ -109,9 +109,7 @@ Even if you have node and npm installed on your windows, it would not be accessi

### Line endings

By default git would use `CRLF` line endings which would cause the scripts to fail. You can change it for this repo only by setting `autocrlf` to false.
`git config core.autocrlf false`
You can also enable it for all your repos by using the `--global` flag
By default git would use `CRLF` line endings which would cause the scripts to fail. You can change it for this repo only by setting `autocrlf` to false by running `git config core.autocrlf false`. You can also enable it for all your repos by using the `--global` flag if you wish to do so.

## Cutting a Release

Expand Down