1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Merge pull request #14547 from amenonsen/github-templates

Update GitHub ISSUE and PULL_REQUEST templates
This commit is contained in:
Brian Coca 2016-02-18 09:09:55 -08:00
commit 10b3738664
3 changed files with 76 additions and 39 deletions

49
ISSUE_TEMPLATE.md Normal file
View file

@ -0,0 +1,49 @@
##### Issue Type:
Please pick one and delete the rest:
- Bug Report
- Feature Idea
- Documentation Report
##### Ansible Version:
```
(Paste verbatim output from “ansible --version” here)
```
##### Ansible Configuration:
Please mention any settings you've 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.
##### Summary:
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)
```
You can also paste gist.github.com links for larger files.
##### Expected Results:
What did you expect to happen when running the steps above?
##### Actual Results:
What actually happened?
```
(Paste verbatim command output here)
```

27
PULL_REQUEST_TEMPLATE.md Normal file
View file

@ -0,0 +1,27 @@
##### Issue Type:
Please pick one and delete the rest:
- Feature Pull Request
- New Module Pull Request
- Bugfix Pull Request
- Docs Pull Request
##### Ansible Version:
```
(Paste verbatim output from “ansible --version” here)
```
##### 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:
```
(Paste verbatim command output here if necessary)
```

View file

@ -1,39 +0,0 @@
##### 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
##### 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!
##### 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.
##### 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 doesnt apply, just say “N/A”. Not all tickets may be about operating system related things and we understand that.
##### 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!
##### 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!
##### 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.
##### 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!