From fe286f1833398720571833ecb05cd74d51bdd6c4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= <slorber@users.noreply.github.com>
Date: Fri, 29 Apr 2022 18:49:05 +0200
Subject: [PATCH] misc: add links section to PR template (#7266)

* add links section to PR template

* wording

* wording

* update template

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
---
 .github/PULL_REQUEST_TEMPLATE.md | 42 ++++++++++++++++++++++----------
 1 file changed, 29 insertions(+), 13 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index fa69d62f36..575fcbf8eb 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,28 +1,44 @@
 <!--
 Thank you for sending the PR! We appreciate you spending the time to work on these changes.
-
-Help us understand your motivation by explaining why you decided to make this change.
-
 You can learn more about contributing to Docusaurus here: https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md
-
-If this PR adds or changes functionality, please take some time to update the docs.
-
 Happy contributing!
+-->
 
+## Pre-flight checklist
+
+- [ ] I have read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#pull-requests).
+- [ ] **If this is a code change**: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
+- [ ] **If this is a new API or substantial change**: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.
+
+<!--
+Please also remember to sign the CLA, although you can also sign it after submitting the PR. The CLA is required for us to merge your PR.
+If this PR adds or changes functionality, please take some time to update the docs. You can also write docs after the API design is finalized and the code changes have been approved.
 -->
 
 ## Motivation
 
-<!-- Write your motivation here. -->
-
-### Have you read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#pull-requests)?
-
-<!-- Write your answer here. -->
+<!-- Help us understand your motivation by explaining why you decided to make this change. Does this fix a bug? Does it close an issue? -->
 
 ## Test Plan
 
 <!-- Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos! -->
 
-## Related PRs
+### Test links
 
-<!-- If you haven't already, link to issues/PRs that are related to this change. This helps us develop the context and keep a rich repo history. -->
+<!--
+🙏 Please add an exhaustive list of links relevant to this pull request.
+⏱ This saves maintainers a lot of time during reviews.
+
+- If you changed anything that's displayed on UI, please add a dogfooding page in website/_dogfooding to help us preview the effect. Those tests are deployed at https://docusaurus.io/tests
+- If you changed documentation, please link to the new and updated documentation pages.
+
+After submission, our Netlify bot will post a deploy preview link in comment, in the format of https://deploy-preview-<PR-NUMBER>--docusaurus-2.netlify.app/. Once available, please edit this section with links to the relevant deploy preview pages.
+
+Please don't be afraid to change the main site's configuration as well! You can make use of your new feature on our site so we can preview its effects. We can decide if it should be kept in production before merging it.
+-->
+
+Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
+
+## Related issues/PRs
+
+<!-- If you haven't already, link to issues/PRs that are related to this change. This helps us develop the context and keep a rich repo history. If this PR is a continuation of a past PR's work, link to that PR. If the PR addresses part of the problem in a meta-issue, mention that issue. -->