From 5446c47c1df4bbe783e1d5c61ccc9cb94e000331 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 (cherry picked from commit bfd5b1878e6eeebd8899bd221cb62ddc046c875d) --- .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++++++ docs/contributing/how-to-contribute.md | 3 ++- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..4a2bf79a20 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +**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. 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)