Merge pull request #14620 from dagwieers/improve-templates

Put the advice to the user as comments in the template

ISSUE_TEMPLATE.md

@@ -1,6 +1,6 @@
 ##### Issue Type:
 
-Please pick one and delete the rest:
+<!--- Please pick one and delete the rest: -->
  - Bug Report
  - Feature Idea
  - Documentation Report
@@ -8,42 +8,48 @@ Please pick one and delete the rest:
 ##### Ansible Version:
 
 ```
-(Paste verbatim output from “ansible --version” here)
+<!--- Paste verbatim output from “ansible --version” here -->
 ```
 
 ##### Ansible Configuration:
 
-Please mention any settings you've changed/added/removed in ansible.cfg
+<!---
+Please mention any settings you have changed/added/removed in ansible.cfg
 (or using the ANSIBLE_* environment variables).
+-->
 
 ##### Environment:
 
+<!---
 Please mention the OS you are running Ansible from, and the OS you are
-managing, or say “N/A” for anything that isn't platform-specific.
+managing, or say “N/A” for anything that is not platform-specific.
+-->
 
 ##### Summary:
 
-Please explain the problem briefly.
+<!--- Please explain the problem briefly -->
 
 ##### Steps To Reproduce:
 
+<!---
 For bugs, please show exactly how to reproduce the problem. For new
 features, show how the feature would be used.
+-->
 
 ```
-(Paste example playbooks or commands here)
+<!--- Paste example playbooks or commands here -->
 ```
 
-You can also paste gist.github.com links for larger files.
+<!--- You can also paste gist.github.com links for larger files -->
 
 ##### Expected Results:
 
-What did you expect to happen when running the steps above?
+<!--- What did you expect to happen when running the steps above? -->
 
 ##### Actual Results:
 
-What actually happened?
+<!--- What actually happened? -->
 
 ```
-(Paste verbatim command output here)
+<!--- Paste verbatim command output here -->
 ```

PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 ##### Issue Type:
 
-Please pick one and delete the rest:
+<!--- Please pick one and delete the rest: -->
  - Feature Pull Request
  - New Module Pull Request
  - Bugfix Pull Request
@@ -9,19 +9,21 @@ Please pick one and delete the rest:
 ##### Ansible Version:
 
 ```
-(Paste verbatim output from “ansible --version” here)
+<!--- Paste verbatim output from “ansible --version” here -->
 ```
 
 ##### Summary:
 
-Please describe the change and the reason for it.
+<!--- Please describe the change and the reason for it -->
 
-(If you're fixing an existing issue, please include "Fixes #nnn" in your
+<!---
+If you are fixing an existing issue, please include "Fixes #nnn" in your
 commit message and your description; but you should still explain what
-the change does.)
+the change does.
+-->
 
 ##### Example output:
 
 ```
-(Paste verbatim command output here if necessary)
+<!-- Paste verbatim command output here if necessary -->
 ```