diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1676421341..82b74cef3c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,12 @@ **Before submitting a pull request,** please make sure the following is done: 1. Fork [the repository](https://github.com/facebook/react) and create your branch from `master`. -2. If you've added code that should be tested, add tests! -3. If you've changed APIs, update the documentation. -4. Ensure the test suite passes (`npm test`). -5. Format your code with [prettier](https://github.com/prettier/prettier) (`npm run prettier`). -6. Make sure your code lints (`npm run lint`). -7. Run the [Flow](https://flowtype.org/) typechecks (`npm run flow`). +2. Run `yarn` in the repository root. +3. If you've fixed a bug or added code that should be tested, add tests! +4. Ensure the test suite passes (`yarn test`). Tip: `yarn test --watch TestName` is helpful in development. +5. Format your code with [prettier](https://github.com/prettier/prettier) (`yarn prettier`). +6. Make sure your code lints (`yarn lint`). Tip: `yarn linc` to only check changed files. +7. Run the [Flow](https://flowtype.org/) typechecks (`yarn flow`). 8. If you haven't already, complete the CLA. + +**Learn more about contributing:** https://reactjs.org/docs/how-to-contribute.html