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
+8-10
Original file line number
Diff line number
Diff line change
@@ -75,20 +75,18 @@ All functionality must be retained (and configuration given to the user) if they
75
75
76
76
1. Clone the repo with `git clone https://github.com/facebookincubator/create-react-app`
77
77
78
-
2. Run `npm install` in the root `create-react-app` folder.
78
+
2. Run `yarn` in the root `create-react-app` folder.
79
79
80
-
Once it is done, you can modify any file locally and run `npm start`, `npm test` or `npm run build` just like in a generated project.
80
+
Once it is done, you can modify any file locally and run `yarn start`, `yarn test` or `yarn build` just like in a generated project.
81
81
82
82
If you want to try out the end-to-end flow with the global CLI, you can do this too:
83
83
84
84
```
85
-
npm run create-react-app my-app
85
+
yarn create-react-app my-app
86
86
cd my-app
87
87
```
88
88
89
-
and then run `npm start` or `npm run build`.
90
-
91
-
*Note: if you are using yarn, we suggest that you use `yarn install --no-lockfile` instead of the bare `yarn` or `yarn install` because we [intentionally](https://github.com/facebookincubator/create-react-app/pull/2014#issuecomment-300811661) do not ignore or add yarn.lock to our repo.*
89
+
and then run `yarn start` or `yarn build`.
92
90
93
91
## Contributing to E2E (end to end) tests
94
92
@@ -104,8 +102,8 @@ The scripts in tasks folder and other scripts in `package.json` will not work in
104
102
105
103
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
104
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.
105
+
### Install Node.js and yarn
106
+
Even if you have node and yarn 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
107
110
108
### Line endings
111
109
@@ -119,11 +117,11 @@ By default git would use `CRLF` line endings which would cause the scripts to fa
119
117
4. Note that files in `packages/create-react-app` should be modified with extreme caution. Since it’s a global CLI, any version of `create-react-app` (global CLI) including very old ones should work with the latest version of `react-scripts`.
120
118
5. Create a change log entry for the release:
121
119
* You'll need an [access token for the GitHub API](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Save it to this environment variable: `export GITHUB_AUTH="..."`
122
-
* Run `npm run changelog`. The command will find all the labeled pull requests merged since the last release and group them by the label and affected packages, and create a change log entry with all the changes and links to PRs and their authors. Copy and paste it to `CHANGELOG.md`.
120
+
* Run `yarn changelog`. The command will find all the labeled pull requests merged since the last release and group them by the label and affected packages, and create a change log entry with all the changes and links to PRs and their authors. Copy and paste it to `CHANGELOG.md`.
123
121
* Add a four-space indented paragraph after each non-trivial list item, explaining what changed and why. For each breaking change also write who it affects and instructions for migrating existing code.
124
122
* Maybe add some newlines here and there. Preview the result on GitHub to get a feel for it. Changelog generator output is a bit too terse for my taste, so try to make it visually pleasing and well grouped.
125
123
6. Make sure to include “Migrating from ...” instructions for the previous release. Often you can copy and paste them.
126
-
7.**Do not run `npm publish`. Instead, run `npm run publish`.**
124
+
7.Run `yarn run publish`. (Don’t forget the `run` there.)
127
125
8. Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
128
126
9. After publishing, create a GitHub Release with the same text as the changelog entry. See previous Releases for inspiration.
0 commit comments