From 915531acc44edca76ff1f4f0061e8c4af5c60b59 Mon Sep 17 00:00:00 2001
From: Maikel <maikel@email.org.au>
Date: Mon, 30 Jul 2018 14:44:07 +1000
Subject: [PATCH] Add section about documentation updates

This should prevent issues like https://github.com/openfoodfoundation/openfoodnetwork/issues/2427.

Also converted comments into HTML syntax so that you don't have to delete them when creating a PR.
---
 .github/PULL_REQUEST_TEMPLATE.md | 38 ++++++++++++++++++++------------
 1 file changed, 24 insertions(+), 14 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index a0c8f5638b..86e4725518 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,36 +2,46 @@
 
 Closes #[the issue number this PR is related to]
 
-[Explain why is this change needed and the solution you propose. Provide
-context for others to understand it]
+<!-- Explain why this change is needed and the solution you propose.
+Provide context for others to understand it. -->
+
+
 
 #### What should we test?
+<!-- List which features should be tested and how. -->
 
-[List which features should be tested and how]
 
-[Should we test on mobile?]
 
 #### Release notes
+<!-- Write a line or two to be included in the release notes.
+Everything is worth mentioning, because you did it for a reason. -->
 
-[In case this should be present in the release notes, please write them or
-remove this section otherwise]
 
-[To streamline the release process, please designate your PR with ONE of the following 
-categories, based on the specification from keepachangelog.com (and delete the others):]
+
+<!-- Please assign one category to your PR and delete the others. 
+The categories are based on https://keepachangelog.com/en/1.0.0/. -->
 
 Changelog Category: Added | Changed | Deprecated | Removed | Fixed | Security
 
 #### How is this related to the Spree upgrade?
+<!-- Any known conflicts with the Spree Upgrade?
+Explain them or remove this section. -->
+
 
-[Any known conflicts with the Spree Upgrade? explain them or remove this section
-otherwise]
 
 #### Discourse thread
+<!-- Is there a discussion about this in Discourse?
+Add the link or remove this section. -->
+
 
-[Is there a discussion about this in Discourse? add the link if so or remove
-this section otherwise]
 
 #### Dependencies
+<!-- Does this PR depend on another one?
+Add the link or remove this section. -->
+
+
+
+#### Documentation updates
+<!-- Are their any wiki pages that need updating after merging this PR?
+List them here or remove this section. -->
 
-[Does this PR depend on another one? add the link of so or remove this section
-otherwise]