diff options
| author | Brian Coca <bcoca@ansible.com> | 2016-03-23 07:05:03 -0700 |
|---|---|---|
| committer | Brian Coca <bcoca@ansible.com> | 2016-03-23 07:05:03 -0700 |
| commit | 5a639a63896ac280a315ecd3c782060986d43223 (patch) | |
| tree | 0aa12e0f2ce8a6636584fcaff64ce9a8632f54c1 | |
| parent | 72e111ecca607c98bea1f20966283870e9304941 (diff) | |
| parent | e4701b12eedaa04fdce0d3746b2f91b445d958df (diff) | |
| download | ansible-5a639a63896ac280a315ecd3c782060986d43223.tar.gz | |
Merge pull request #15118 from dagwieers/github-dir
Various improvements to issue/pull-request templates
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 41 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 19 |
2 files changed, 25 insertions, 35 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 56907da419..eb52119564 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,55 +1,50 @@ -##### Issue Type: +<!--- Verify first that your issue/request is not already reported in GitHub --> -<!--- Please pick one and delete the rest: --> +##### ISSUE TYPE +<!--- Pick one below and delete the rest: --> - Bug Report - Feature Idea - Documentation Report -##### Ansible Version: +##### ANSIBLE VERSION ``` -<!--- Paste verbatim output from “ansible --version” here --> +<!--- Paste verbatim output from “ansible --version” between quotes --> ``` -##### Ansible Configuration: - +##### CONFIGURATION <!--- -Please mention any settings you have changed/added/removed in ansible.cfg +Mention any settings you have changed/added/removed in ansible.cfg (or using the ANSIBLE_* environment variables). --> -##### Environment: - +##### OS / ENVIRONMENT <!--- -Please mention the OS you are running Ansible from, and the OS you are +Mention the OS you are running Ansible from, and the OS you are managing, or say “N/A” for anything that is not platform-specific. --> -##### Summary: - -<!--- Please explain the problem briefly --> - -##### Steps To Reproduce: +##### SUMMARY +<!--- 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. +For bugs, 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 between quotes --> ``` <!--- You can also paste gist.github.com links for larger files --> -##### Expected Results: - +##### EXPECTED RESULTS <!--- What did you expect to happen when running the steps above? --> -##### Actual Results: - +##### ACTUAL RESULTS <!--- What actually happened? If possible run with high verbosity (-vvvv) --> ``` -<!--- Paste verbatim command output here --> +<!--- Paste verbatim command output between quotes --> ``` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3c348908ed..b9a1918530 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,20 +1,17 @@ -##### Issue Type: - -<!--- Please pick one and delete the rest: --> +##### ISSUE TYPE +<!--- Pick one below and delete the rest: --> - Feature Pull Request - New Module Pull Request - Bugfix Pull Request - Docs Pull Request -##### Ansible Version: - +##### ANSIBLE VERSION ``` -<!--- Paste verbatim output from “ansible --version” here --> +<!--- Paste verbatim output from “ansible --version” between quotes --> ``` -##### Summary: - -<!--- Please describe the change and the reason for it --> +##### SUMMARY +<!--- Describe the change, including rationale and design decisions --> <!--- If you are fixing an existing issue, please include "Fixes #nnn" in your @@ -22,8 +19,6 @@ commit message and your description; but you should still explain what the change does. --> -##### Example output: - ``` -<!-- Paste verbatim command output here if necessary --> +<!-- Paste verbatim command output here, e.g. before and after your change --> ``` |