You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15
Original file line number
Diff line number
Diff line change
@@ -96,6 +96,21 @@ and then run `npm start` or `npm run build`.
96
96
97
97
More detailed information are in the dedicated [README](/packages/react-scripts/fixtures/kitchensink/README.md).
98
98
99
+
## Tips for contributors using Windows
100
+
101
+
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:
102
+
103
+
### Install Bash on Ubuntu on Windows
104
+
105
+
A good step by step guide can be found [here](https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/)
106
+
107
+
### Install Node.js and npm
108
+
Even if you have node and npm installed on your windows, it would not be accessible from the bash shell. You would have to install it again. Installing via [`nvm`](https://github.com/creationix/nvm#install-script) is recommended.
109
+
110
+
### Line endings
111
+
112
+
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.
113
+
99
114
## Cutting a Release
100
115
101
116
1. Tag all merged pull requests that go into the release with the relevant milestone. Each merged PR should also be labeled with one of the [labels](https://github.com/facebookincubator/create-react-app/labels) named `tag: ...` to indicate what kind of change it is.
0 commit comments