ansible/.github/ISSUE_TEMPLATE.md

<!---
Verify first that your issue/request is not already reported on GitHub.
Also test if the latest release, and devel branch are affected too.
Always add information AFTER of these html comments. -->

##### ISSUE TYPE
<!--- Pick one below and delete the rest -->
 - Bug Report
 - Feature Idea
 - 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-->

##### ANSIBLE VERSION
<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes 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).-->

##### 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.-->

##### SUMMARY
<!--- Explain the problem briefly -->

##### 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. -->

<!--- Paste example playbooks or commands between quotes below -->
```yaml

```

<!--- 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? If possible run with extra verbosity (-vvvv) -->

<!--- Paste verbatim command output between quotes below -->
```

```
Try to avoid module-related tickets in the core Ansible project (#17047) * Try to avoid module-related tickets in the core Ansible project Since most users still report module-related problems in the Ansible core GitHub project, I added a warning at the top of the template. Maybe it could help if the various projects would have more specific names ? - ansible/ansible -> ansible/main (or something even better ?) - ansible/ansible-modules-core -> ansible/modules-core - ansible/ansible-modules-extras -> ansible/modules-extras I am sure someone can come up with perfect names ;-) * Remove 'module' from the component options I would prefer to again note that modules should go elsewhere, but don't want to bloat the text too much. 8 years ago			`<!---`
Remove the hint to report module issue elsewhere. 8 years ago			`Verify first that your issue/request is not already reported on GitHub.`
There is no master branch in this project (#35773) Since there is no master branch, best not to mention it in the issue template to avoid confusion. 7 years ago			`Also test if the latest release, and devel branch are affected too.`
Update Issue & PR templates to make them clearer Try and reduce people typing in the comments section 7 years ago			`Always add information AFTER of these html comments. -->`
Try to avoid module-related tickets in the core Ansible project (#17047) * Try to avoid module-related tickets in the core Ansible project Since most users still report module-related problems in the Ansible core GitHub project, I added a warning at the top of the template. Maybe it could help if the various projects would have more specific names ? - ansible/ansible -> ansible/main (or something even better ?) - ansible/ansible-modules-core -> ansible/modules-core - ansible/ansible-modules-extras -> ansible/modules-extras I am sure someone can come up with perfect names ;-) * Remove 'module' from the component options I would prefer to again note that modules should go elsewhere, but don't want to bloat the text too much. 8 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### ISSUE TYPE`
Fix closing tag for COMPONENT NAME, multiline changes 7 years ago			`<!--- Pick one below 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. 9 years ago			`- Bug Report`
			`- Feature Idea`
			`- Documentation Report`
Moving the github issue template file to this repo 10 years ago
Add Component Name to the issue and pr templates (#17019) 8 years ago			`##### COMPONENT NAME`
Update Issue & PR templates to make them clearer Try and reduce people typing in the comments section 7 years ago			`<!--- 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-->`
Moving the github issue template file to this repo 10 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### ANSIBLE VERSION`
BELOW THIS COMMENT 7 years ago			`<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below -->`
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out. 9 years ago			```
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections. 9 years ago
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out. 9 years ago			```
Moving the github issue template file to this repo 10 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### CONFIGURATION`
Update Issue & PR templates to make them clearer Try and reduce people typing in the comments section 7 years ago			`<!--- If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed"`
added note about ansible-config to issue template 7 years ago			`Otherwise, mention any settings you have changed/added/removed in ansible.cfg`
Update Issue & PR templates to make them clearer Try and reduce people typing in the comments section 7 years ago			`(or using the ANSIBLE_* environment variables).-->`
Config might be important for issues. 10 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### OS / ENVIRONMENT`
Update Issue & PR templates to make them clearer Try and reduce people typing in the comments section 7 years ago			`<!--- Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are`
Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago			`managing, or say "N/A" for anything that is not platform-specific.`
Ask for Network OS version info (#25958) 8 years ago			`Also mention the specific version of what you are trying to control,`
Update Issue & PR templates to make them clearer Try and reduce people typing in the comments section 7 years ago			`e.g. if this is a network bug the version of firmware on the network device.-->`
Moving the github issue template file to this repo 10 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### SUMMARY`
One more improvement 9 years ago			`<!--- Explain the problem briefly -->`
Moving the github issue template file to this repo 10 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### STEPS TO REPRODUCE`
Update Issue & PR templates to make them clearer Try and reduce people typing in the comments section 7 years ago			`<!--- For bugs, show exactly how to reproduce the problem, using a minimal test-case.`
			`For new features, show how the feature would be used. -->`
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. 9 years ago
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections. 9 years ago			`<!--- Paste example playbooks or commands between quotes below -->`
Remove the hint to report module issue elsewhere. 8 years ago			```yaml
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections. 9 years ago
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out. 9 years ago			```

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) 9 years ago			`<!--- You can also paste gist.github.com links for larger files -->`
Moving the github issue template file to this repo 10 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### 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) 9 years ago			`<!--- What did you expect to happen when running the steps above? -->`
Moving the github issue template file to this repo 10 years ago
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests) 9 years ago			`##### ACTUAL RESULTS`
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections. 9 years ago			`<!--- What actually happened? If possible run with extra verbosity (-vvvv) -->`
Moving the github issue template file to this repo 10 years ago
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections. 9 years ago			`<!--- Paste verbatim command output between quotes below -->`
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out. 9 years ago			```
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections. 9 years ago
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out. 9 years ago			```