Update Issue & PR templates to make them clearer

Try and reduce people typing in the comments section
This commit is contained in:
John Barker 2018-04-17 11:55:02 +01:00 committed by Brian Coca
parent f5cc4acc53
commit 4e56dcd01a
2 changed files with 13 additions and 27 deletions

View file

@ -1,8 +1,7 @@
<!---
Verify first that your issue/request is not already reported on GitHub.
Also test if the latest release, and devel branch are affected too.
Always add information AFTER of these html comments.
-->
Always add information AFTER of these html comments. -->
##### ISSUE TYPE
<!--- Pick one below and delete the rest -->
@ -11,10 +10,8 @@ Always add information AFTER of these html comments.
- Documentation Report
##### COMPONENT NAME
<!---
Insert, BELOW THIS COMMENT, the name of the module, plugin, task or feature.
Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path
-->
<!--- Insert, BELOW THIS COMMENT, the name of the module, plugin, task or feature.
Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path-->
##### ANSIBLE VERSION
<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below -->
@ -23,29 +20,22 @@ Do not include extra details here, e.g. "vyos_command" not "the network module v
```
##### CONFIGURATION
<!---
If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed"
<!--- If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed"
Otherwise, mention any settings you have changed/added/removed in ansible.cfg
(or using the ANSIBLE_* environment variables).
-->
(or using the ANSIBLE_* environment variables).-->
##### OS / ENVIRONMENT
<!---
Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are
<!--- Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are
managing, or say "N/A" for anything that is not platform-specific.
Also mention the specific version of what you are trying to control,
e.g. if this is a network bug the version of firmware on the network device.
-->
e.g. if this is a network bug the version of firmware on the network device.-->
##### SUMMARY
<!--- Explain the problem briefly -->
##### STEPS TO REPRODUCE
<!---
For bugs, show exactly how to reproduce the problem, using a minimal test-case.
For new features, show how the feature would be used.
-->
<!--- For bugs, show exactly how to reproduce the problem, using a minimal test-case.
For new features, show how the feature would be used. -->
<!--- Paste example playbooks or commands between quotes below -->
```yaml

View file

@ -1,11 +1,9 @@
##### SUMMARY
<!--- Describe the change, including rationale and design decisions -->
<!---
If you are 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.-->
##### ISSUE TYPE
<!--- Pick one below and delete the rest: -->
@ -25,11 +23,9 @@ the change does.
##### ADDITIONAL INFORMATION
<!---
Include additional information to help people understand the change here.
<!--- Include additional information to help people understand the change here.
For bugs that don't have a linked bug report, a step-by-step reproduction
of the problem is helpful.
-->
of the problem is helpful. -->
<!--- Paste verbatim command output below, e.g. before and after your change -->
```