From 431d082771179eecef7d7e871ae9c7c5b61929e8 Mon Sep 17 00:00:00 2001 From: sebastienlorber Date: Fri, 29 Apr 2022 15:53:10 +0200 Subject: [PATCH 1/4] add links section to PR template --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fa69d62f365f..c26189f93654 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,6 +23,14 @@ Happy contributing! -## Related PRs +## Links - + From 60273f5a2f78c73936f25c819f60dcb7b2d5ad14 Mon Sep 17 00:00:00 2001 From: sebastienlorber Date: Fri, 29 Apr 2022 15:58:31 +0200 Subject: [PATCH 2/4] wording --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c26189f93654..d9c45e642d2a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -31,6 +31,6 @@ Happy contributing! Example: - 🔗 link to new and updated documentation pages, using the deploy preview -- 🔗 link to test pages: you can add tests to docusaurus/website/_dogfooding, those are deployed at https://docusaurus.io/tests +- 🔗 link to test pages: you can add tests in docusaurus/website/_dogfooding to help us review code changes. Those tests are deployed at https://docusaurus.io/tests - 🔗 link to related pull-requests and issues --> From 9bb976f07fd9265b0d22ce26caf7bcf9b010a064 Mon Sep 17 00:00:00 2001 From: sebastienlorber Date: Fri, 29 Apr 2022 17:36:42 +0200 Subject: [PATCH 3/4] wording --- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d9c45e642d2a..b6a1a7c896ad 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -30,7 +30,11 @@ Happy contributing! ⏱ This saves maintainers a lot of time during reviews. Example: -- 🔗 link to new and updated documentation pages, using the deploy preview -- 🔗 link to test pages: you can add tests in docusaurus/website/_dogfooding to help us review code changes. Those tests are deployed at https://docusaurus.io/tests -- 🔗 link to related pull-requests and issues +- link to new and updated documentation pages. +- link to test pages: you can add tests in docusaurus/website/_dogfooding to help us review code changes. Those tests are deployed at https://docusaurus.io/tests +- link to related pull-requests and issues + +After submission, our Netlify bot will post a deploy preview link in comment. +Example: https://deploy-preview---docusaurus-2.netlify.app/ +Once available, please edit this section with deploy-preview docs/tests links. --> From 3d025ad7a3cd4aaa73cfe65aeb16b5b5474fff5d Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Sat, 30 Apr 2022 00:01:56 +0800 Subject: [PATCH 4/4] update template --- .github/PULL_REQUEST_TEMPLATE.md | 42 +++++++++++++++++--------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b6a1a7c896ad..575fcbf8eb57 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,40 +1,44 @@ -If this PR adds or changes functionality, please take some time to update the docs. +## Pre-flight checklist -Happy contributing! +- [ ] 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. + ## Motivation - - -### Have you read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#pull-requests)? - - + ## Test Plan -## Links +### Test links + +Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/ + +## Related issues/PRs + +