wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ansible/.github/ISSUE_TEMPLATE.md

56 lines
1.1 KiB
Markdown
Raw Normal View History

Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
##### Issue Type:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!--- Please pick one and delete the rest: -->
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.
2016-02-18 03:23:40 +00:00
- Bug Report
- Feature Idea
- Documentation Report
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
##### Ansible Version:
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!--- Paste verbatim output from “ansible --version” here -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
Config might be important for issues.
2015-05-07 22:24:33 +00:00
##### Ansible Configuration:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!---
Please mention any settings you have changed/added/removed in ansible.cfg
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.
2016-02-18 03:23:40 +00:00
(or using the ANSIBLE_* environment variables).
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
-->
Config might be important for issues.
2015-05-07 22:24:33 +00:00
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
##### Environment:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!---
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.
2016-02-18 03:23:40 +00:00
Please mention the OS you are running Ansible from, and the OS you are
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
managing, or say “N/A” for anything that is not platform-specific.
-->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
##### Summary:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!--- Please explain the problem briefly -->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
##### Steps To Reproduce:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!---
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.
2016-02-18 03:23:40 +00:00
For bugs, please show exactly how to reproduce the problem. For new
features, show how the feature would be used.
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
-->
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.
2016-02-18 03:23:40 +00:00
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!--- Paste example playbooks or commands here -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!--- You can also paste gist.github.com links for larger files -->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
##### Expected Results:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!--- What did you expect to happen when running the steps above? -->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
##### Actual Results:
added note for verbosity
2016-02-25 00:21:43 +00:00
<!--- What actually happened? If possible run with high verbosity (-vvvv) -->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 11:15:24 +00:00
<!--- Paste verbatim command output here -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Reference in a new issue Copy permalink