From 060585a87c8e88ad1fc50d8cb0e05d2ff725a907 Mon Sep 17 00:00:00 2001
From: Zac Sweers <zac.sweers@gmail.com>
Date: Sun, 8 Oct 2017 21:58:33 -0700
Subject: [PATCH] Update templates to use html comments

These comments won't show up in the final markdown, allowing us to put the verbose wording in them and keep the actual content light
---
 .github/ISSUE_TEMPLATE.md        | 12 +++++++++---
 .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++----
 2 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index f2a5628d7..9628a48a8 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,5 +1,11 @@
-Thanks for using AutoDispose. Before you create an issue, please consider the following points:
+<!--
+Thanks for using AutoDispose. Before you create an issue, please consider the following points to help us best diagnose the issue.
+Feel free to remove any irrelevant parts that you know are not related to the issue.
+Any HTML comment like this will be stripped when rendering markdown, no need to delete them.
+-->
 
-  - [ ] If you think you found a bug, please include a code sample that reproduces the problem. A stacktrace alone is ok too, but may not contain enough context for us to deduce the issue from.
+<!-- Please include the library version number, including the minor and patch version (like `1.0.0`), in the issue text. -->
+**Library version**:
 
-  - [ ] Please include the library version number, including the minor and patch version, in the issue text.
+<!-- If you think you found a bug, please include a code sample that reproduces the problem. A stacktrace alone is ok too, but may not contain enough context for us to deduce the issue from. -->
+**Repro steps or stacktrace**:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index e1dcbacb5..3eb40d878 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,13 @@
-Thank you for contributing to AutoDispose. Before pressing the "Create Pull Request" button, please consider the following points: 
+<!--
+Thank you for contributing to AutoDispose. Before pressing the "Create Pull Request" button, please consider the following points.
+Feel free to remove any irrelevant parts that you know are not related to the issue.
+Any HTML comment like this will be stripped when rendering markdown, no need to delete them.
+-->
 
-  - [ ] Please give a description about what and why you are contributing, even if it's trivial.
+<!-- Please give a description about what and why you are contributing, even if it's trivial. -->
+**Description**:
 
-  - [ ] Please include the issue list number(s) or other PR numbers in the description if you are contributing in response to those.
+<!-- Please include the issue list number(s) or other PR numbers in the description if you are contributing in response to those. -->
+**Related issue(s)**:
 
-  - [ ] Please include a reasonable set of unit tests if you contribute new code or change an existing one.
+<!-- Please include a reasonable set of unit tests if you contribute new code or change an existing one. -->