From bfd5b1878e6eeebd8899bd221cb62ddc046c875d Mon Sep 17 00:00:00 2001 From: Jack Cross Date: Tue, 17 Jan 2017 09:34:44 -0500 Subject: [PATCH] Add Flow reminder to PR template (#8805) * Added flow to PR template * Added record-tests step to PR template and contribution docs * Updated order of PR checks --- .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++---- docs/contributing/how-to-contribute.md | 3 ++- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 29654a4773..4a2bf79a20 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,10 @@ -*Before* submitting a pull request, please make sure the following is done... +**Before submitting a pull request,** please make sure the following is done: -1. Fork the repo and create your branch from `master`. +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. Make sure your code lints (`npm run lint`) - we've done our best to make sure these rules match our internal linting guidelines. -6. If you haven't already, complete the [CLA](https://code.facebook.com/cla). +5. Make sure your code lints (`npm run lint`). +6. Run the [Flow](https://flowtype.org/) typechecks (`npm run flow`). +7. If you added or removed any tests, run `./scripts/fiber/record-tests` before submitting the pull request, and commit the resulting changes. +8. If you haven't already, complete the [CLA](https://code.facebook.com/cla). diff --git a/docs/contributing/how-to-contribute.md b/docs/contributing/how-to-contribute.md index 4beaabeac9..e1a10c74f9 100644 --- a/docs/contributing/how-to-contribute.md +++ b/docs/contributing/how-to-contribute.md @@ -82,7 +82,8 @@ The core team is monitoring for pull requests. We will review your pull request 4. Ensure the test suite passes (`npm test`). 5. Make sure your code lints (`npm run lint`). 6. Run the [Flow](https://flowtype.org/) typechecks (`npm run flow`). -7. If you haven't already, complete the CLA. +7. If you added or removed any tests, run `./scripts/fiber/record-tests` before submitting the pull request, and commit the resulting changes. +8. If you haven't already, complete the CLA. ### Contributor License Agreement (CLA)