From 905b156133b200b5df5ff45e2a665e53990030d3 Mon Sep 17 00:00:00 2001 From: Abhijit Menon-Sen Date: Thu, 18 Feb 2016 08:53:40 +0530 Subject: [PATCH 1/4] Edit the ISSUE_TEMPLATE The old template was effusive at the expense of making the text harder to read and easier to miss things in. This one is more direct, and easy to scan quickly. --- issue_template.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/issue_template.md b/issue_template.md index 094501db90..f20486fe6e 100644 --- a/issue_template.md +++ b/issue_template.md @@ -1,39 +1,47 @@ ##### Issue Type: -Can you help us out in labelling this by telling us what kind of ticket this this? You can say: - - Bug Report - - Feature Idea - - Feature Pull Request - - New Module Pull Request - - Bugfix Pull Request - - Documentation Report - - Docs Pull Request +Please pick one and delete the rest: + - Bug Report + - Feature Idea + - Feature Pull Request + - New Module Pull Request + - Bugfix Pull Request + - Documentation Report + - Docs Pull Request ##### Ansible Version: -Let us know what version of Ansible you are using. Please supply the verbatim output from running “ansible --version”. If you're filing a ticket on a version of Ansible which is not the latest, we'd greatly appreciate it if you could retest on the latest version first. We don't expect you to test against the development branch most of the time, but we may ask for that if you have cycles. Thanks! +Please paste the verbatim output from running “ansible --version”. ##### Ansible Configuration: -What have you changed about your Ansible installation? What configuration settings have you changed/added/removed? Compare your /etc/ansible/ansible.cfg against a clean version from Github and let us know what's different. +Please mention any settings you've changed/added/removed in ansible.cfg +(or using the ANSIBLE_* environment variables). ##### Environment: -What OS are you running Ansible from and what OS are you managing? Examples include RHEL 5/6, Centos 5/6, Ubuntu 12.04/13.10, *BSD, Solaris. If this is a generic feature request or it doesn’t apply, just say “N/A”. Not all tickets may be about operating system related things and we understand that. +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. ##### Summary: -Please summarize your request in this space. You will earn bonus points for being succinct, but please add enough detail so we can understand the request. Thanks! +Please explain the problem briefly. ##### Steps To Reproduce: -If this is a bug ticket, please enter the steps you use to reproduce the problem in the space below. If this is a feature request, please enter the steps you would use to use the feature. If an example playbook is useful, please include a short reproducer inline, indented by four spaces. If a longer one is necessary, linking to one uploaded to gist.github.com would be great. Much appreciated! +For bugs, please show exactly how to reproduce the problem. For new +features, show how the feature would be used. + +You can include example playbooks inline (indented by four spaces) or +upload larger ones to gist.github.com and paste a link here. ##### Expected Results: -Please enter your expected results in this space. When running the steps supplied above in the previous section, what did you expect to happen? If showing example output, please indent your output by four spaces so it will render correctly in GitHub's viewer thingy. +What did you expect to happen when running the steps above? ##### Actual Results: -Please enter your actual results in this space. When running the steps supplied above, what actually happened? If you are showing example output, please indent your output by four spaces so it will render correctly in GitHub. Thanks again! +What actually happened? +(If you're pasting verbatim command output, remember to indent it by +four spaces so it will render correctly in Github.) From ff8b48ca65aa77d9baf8f9d9ea24ca9199a8d7a2 Mon Sep 17 00:00:00 2001 From: Abhijit Menon-Sen Date: Thu, 18 Feb 2016 09:10:12 +0530 Subject: [PATCH 2/4] Create a PULL_REQUEST_TEMPLATE Now that Github supports separate issue and PR templates, we can have a separate cut-down version for PRs without all the things we ask for in a new issue. The PR types are also removed from the ISSUE_TEMPLATE. --- PULL_REQUEST_TEMPLATE.md | 23 +++++++++++++++++++++++ issue_template.md | 4 ---- 2 files changed, 23 insertions(+), 4 deletions(-) create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..bb64deb50d --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +##### Issue Type: + +Please pick one and delete the rest: + - Feature Pull Request + - New Module Pull Request + - Bugfix Pull Request + - Docs Pull Request + +##### Ansible Version: + +Please paste the verbatim output from running “ansible --version”. + +##### Summary: + +Please describe the change and the reason for it. + +(If you're fixing an existing issue, please include "Fixes #nnn" in your +commit message and your description; but you should still explain what +the change does.) + +##### Example output: + +If necessary, paste example output (indented by four spaces) here. diff --git a/issue_template.md b/issue_template.md index f20486fe6e..57ef3c90f6 100644 --- a/issue_template.md +++ b/issue_template.md @@ -3,11 +3,7 @@ Please pick one and delete the rest: - Bug Report - Feature Idea - - Feature Pull Request - - New Module Pull Request - - Bugfix Pull Request - Documentation Report - - Docs Pull Request ##### Ansible Version: From 2c723a135b2b9f9885ef9d440f70d1509c1fe881 Mon Sep 17 00:00:00 2001 From: Abhijit Menon-Sen Date: Thu, 18 Feb 2016 09:16:37 +0530 Subject: [PATCH 3/4] Rename issue_template.md back to ISSUE_TEMPLATE.md I can only assume that it was renamed because Github suddenly started to act on ISSUE_TEMPLATE; but that's what we want now, so back it goes. --- issue_template.md => ISSUE_TEMPLATE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename issue_template.md => ISSUE_TEMPLATE.md (100%) diff --git a/issue_template.md b/ISSUE_TEMPLATE.md similarity index 100% rename from issue_template.md rename to ISSUE_TEMPLATE.md From 54cd2069e616ffd0d16e6d641daf5f1883a94492 Mon Sep 17 00:00:00 2001 From: Abhijit Menon-Sen Date: Thu, 18 Feb 2016 16:11:47 +0530 Subject: [PATCH 4/4] Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out. --- ISSUE_TEMPLATE.md | 16 +++++++++++----- PULL_REQUEST_TEMPLATE.md | 8 ++++++-- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 57ef3c90f6..e67be84a3c 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -7,7 +7,9 @@ Please pick one and delete the rest: ##### Ansible Version: -Please paste the verbatim output from running “ansible --version”. +``` +(Paste verbatim output from “ansible --version” here) +``` ##### Ansible Configuration: @@ -28,8 +30,11 @@ Please explain the problem briefly. For bugs, please show exactly how to reproduce the problem. For new features, show how the feature would be used. -You can include example playbooks inline (indented by four spaces) or -upload larger ones to gist.github.com and paste a link here. +``` +(Paste example playbooks or commands here) +``` + +You can also paste gist.github.com links for larger files. ##### Expected Results: @@ -39,5 +44,6 @@ What did you expect to happen when running the steps above? What actually happened? -(If you're pasting verbatim command output, remember to indent it by -four spaces so it will render correctly in Github.) +``` +(Paste verbatim command output here) +``` diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index bb64deb50d..d532449ade 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -8,7 +8,9 @@ Please pick one and delete the rest: ##### Ansible Version: -Please paste the verbatim output from running “ansible --version”. +``` +(Paste verbatim output from “ansible --version” here) +``` ##### Summary: @@ -20,4 +22,6 @@ the change does.) ##### Example output: -If necessary, paste example output (indented by four spaces) here. +``` +(Paste verbatim command output here if necessary) +```