From 7ada789e160e58bb3359d6970e77787872cc0840 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Rodr=C3=ADguez?= <deivid.rodriguez@riseup.net>
Date: Wed, 15 Jan 2020 10:04:02 +0100
Subject: Include also developer problems in first question

---
 .github/PULL_REQUEST_TEMPLATE.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to '.github')

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 67dfa5b2c6..cc824e7e6d 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,7 @@
 Thanks so much for the contribution!
 To make reviewing this PR a bit easier, please fill out answers to the following questions.
 
-### What was the end-user problem that led to this PR?
+### What was the end-user or developer problem that led to this PR?
 
 The problem was...
 
-- 
cgit v1.2.1


From 6bd3642718f527b7e02ac5dfe5cac8c36c6d0bcb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Rodr=C3=ADguez?= <deivid.rodriguez@riseup.net>
Date: Wed, 15 Jan 2020 10:09:28 +0100
Subject: Elaborate a bit on each question

Instead of forcing fixed beginning of the answers, give some more
information on what's expected, but leave the section wording completely
up to the PR author.
---
 .github/PULL_REQUEST_TEMPLATE.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to '.github')

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index cc824e7e6d..6fa31f8b2c 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,16 +3,16 @@ To make reviewing this PR a bit easier, please fill out answers to the following
 
 ### What was the end-user or developer problem that led to this PR?
 
-The problem was...
+<!-- Write a clear and complete description of the problem -->
 
 ### What was your diagnosis of the problem?
 
-My diagnosis was...
+<!-- Explain the investigation you made to determine the cause of the issue and your conclusions -->
 
 ### What is your fix for the problem, implemented in this PR?
 
-My fix...
+<!-- Explain the fix being implemented -->
 
 ### Why did you choose this fix out of the possible options?
 
-I chose this fix because...
+<!-- If you considered other alternatives, explain why you end up choosing the current implementation -->
-- 
cgit v1.2.1


From 2fdfe019126dfbb066286625e08380a627374846 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Rodr=C3=ADguez?= <deivid.rodriguez@riseup.net>
Date: Wed, 15 Jan 2020 10:11:40 +0100
Subject: Squash last three questions into just one

In my experience, for most PRs it is enough to just explain the problem
and explain your fix, and most times it's a bit artificial to fill out
all 4 questions. So, I'm squashing them.
---
 .github/PULL_REQUEST_TEMPLATE.md | 12 +++---------
 1 file changed, 3 insertions(+), 9 deletions(-)

(limited to '.github')

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 6fa31f8b2c..ebe0de95a5 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,14 +5,8 @@ To make reviewing this PR a bit easier, please fill out answers to the following
 
 <!-- Write a clear and complete description of the problem -->
 
-### What was your diagnosis of the problem?
-
-<!-- Explain the investigation you made to determine the cause of the issue and your conclusions -->
-
 ### What is your fix for the problem, implemented in this PR?
 
-<!-- Explain the fix being implemented -->
-
-### Why did you choose this fix out of the possible options?
-
-<!-- If you considered other alternatives, explain why you end up choosing the current implementation -->
+<!-- Explain the fix being implemented. Include any diagnosis you run to
+determine the cause of the issue and your conclusions. If you considered other
+alternatives, explain why you end up choosing the current implementation -->
-- 
cgit v1.2.1


From 63456cf3393f96fc94fa129c7dd1b4b236dbe191 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Rodr=C3=ADguez?= <deivid.rodriguez@riseup.net>
Date: Wed, 15 Jan 2020 10:13:37 +0100
Subject: Hide initial text

So that the author gets the message, but it doesn't appear by default in
the PR's body.
---
 .github/PULL_REQUEST_TEMPLATE.md | 2 ++
 1 file changed, 2 insertions(+)

(limited to '.github')

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index ebe0de95a5..0b3dc2a218 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,7 @@
+<!--
 Thanks so much for the contribution!
 To make reviewing this PR a bit easier, please fill out answers to the following questions.
+-->
 
 ### What was the end-user or developer problem that led to this PR?
 
-- 
cgit v1.2.1


From 9cdd01eea0ef6f68fdfcf582e7d05e0f684ff60c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Rodr=C3=ADguez?= <deivid.rodriguez@riseup.net>
Date: Wed, 15 Jan 2020 10:16:39 +0100
Subject: Add a note about rebuilding documentation

---
 .github/PULL_REQUEST_TEMPLATE.md | 5 +++++
 1 file changed, 5 insertions(+)

(limited to '.github')

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 0b3dc2a218..a721e8bf0d 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,10 @@
 <!--
 Thanks so much for the contribution!
+
+If you're updating documentation, make sure you run `bin/rake man:build` and
+squash the result into your changes, so that all documentation formats are
+updated.
+
 To make reviewing this PR a bit easier, please fill out answers to the following questions.
 -->
 
-- 
cgit v1.2.1