diff options
author | Dag Wieers <dag@wieers.com> | 2018-09-04 17:31:45 +0200 |
---|---|---|
committer | John R Barker <john@johnrbarker.com> | 2018-09-04 17:31:45 +0200 |
commit | 3034709df07d98fc35c01f37ab7bb09e6399d4e5 (patch) | |
tree | 0f43bab1fc4b0235babe5c96f3f07b1933c7f802 /.github/ISSUE_TEMPLATE.md | |
parent | ec2_vpc_route_table - allow routes to be created if the CIDR already exists b... (diff) | |
download | ansible-3034709df07d98fc35c01f37ab7bb09e6399d4e5.tar.xz ansible-3034709df07d98fc35c01f37ab7bb09e6399d4e5.zip |
Improve GitHub templates (#44455)
* Improve GitHub templates
The existing templates are basically a copy for each type of issue (bug,
feature, doc) whereas we can make the template more specific to the task
at hand.
This PR includes:
- More specific sections depending on the type of issue
- More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!)
- Single-line comments (no need to guide people to avoid wrong edits)
- Improved paste area
- Better headings/titles
- No 'Summary' title for PRs (so commit information is placed correctly)
This PR would require some improvements to Ansibot.
* Remove controversial Ansibot stuff
Make it easier to get the first batch merged.
* Restore ISSUE_TEMPLATE.md
* Incorporate reviewer suggestions
* Make OS / ENVIRONMENT doc-related
* Rephrase Ansibot-related message
Diffstat (limited to '.github/ISSUE_TEMPLATE.md')
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 43 |
1 files changed, 18 insertions, 25 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 8242ba2e87..ad3657dc28 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,12 +1,9 @@ -<!--- -Verify first that your issue/request is not already reported on GitHub. -THIS FORM WILL BE READ BY A MACHINE, COMPLETE ALL SECTIONS AS DESCRIBED. -Also test if the latest release, and devel branch are affected too. -ALWAYS add information AFTER (OUTSIDE) these html comments. -Otherwise it may end up being automatically closed by our bot. --> +<!--- Verify first that your issue is not already reported on GitHub --> +<!--- Also test if the latest release and devel branch are affected too --> +<!--- Complete *all* sections as described, this form is processed automatically --> ##### SUMMARY -<!--- Explain the problem briefly --> +<!--- Explain the problem briefly below --> ##### ISSUE TYPE <!--- Pick one below and delete the rest --> @@ -15,44 +12,40 @@ Otherwise it may end up being automatically closed by our bot. --> - 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--> +<!--- Write the short name of the module, plugin, task or feature below --> ##### ANSIBLE VERSION -<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below --> -``` +<!--- Paste verbatim output from "ansible --version" between quotes --> +```paste below ``` ##### CONFIGURATION -<!--- 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).--> +<!--- Paste verbatim output from "ansible-config dump --only-changed" between quotes --> +```paste below + +``` ##### OS / ENVIRONMENT -<!--- 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.--> +<!--- Provide all relevant information below, e.g. target OS versions, network device firmware, etc. --> ##### 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. --> +<!--- Describe exactly how to reproduce the problem, using a minimal test-case --> <!--- Paste example playbooks or commands between quotes below --> ```yaml ``` -<!--- You can also paste gist.github.com links for larger files --> +<!--- HINT: You can paste gist.github.com links for larger files --> ##### EXPECTED RESULTS -<!--- What did you expect to happen when running the steps above? --> +<!--- Describe what you expected to happen when running the steps above --> ##### ACTUAL RESULTS -<!--- What actually happened? If possible run with extra verbosity (-vvvv) --> +<!--- Describe what actually happened. If possible run with extra verbosity (-vvvv) --> -<!--- Paste verbatim command output between quotes below --> -``` +<!--- Paste verbatim command output between quotes --> +```paste below ``` |