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

65 lines
1.7 KiB
Markdown
Raw Normal View History

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.
2016-08-11 14:14:27 +00:00
<!---
Remove the hint to report module issue elsewhere.
2016-12-07 08:50:48 +00:00
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.
2018-02-06 13:37:04 +00:00
Also test if the latest release, and devel branch are affected too.
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.
2016-08-11 14:14:27 +00:00
-->
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)
2016-03-23 12:49:20 +00:00
##### ISSUE TYPE
Fix closing tag for COMPONENT NAME, multiline changes
2017-12-13 09:18:37 +00:00
<!--- 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.
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
Add Component Name to the issue and pr templates (#17019)
2016-08-09 17:18:06 +00:00
##### COMPONENT NAME
Fix closing tag for COMPONENT NAME, multiline changes
2017-12-13 09:18:37 +00:00
<!---
Remove slashes from instructions to avoid confusion
2017-12-15 16:18:31 +00:00
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
2014-09-09 15:59:39 +00:00
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)
2016-03-23 12:49:20 +00:00
##### ANSIBLE VERSION
Add a code-smell test for smart quotes and remove smart quotes from all files
2017-09-18 17:41:17 +00:00
<!--- Paste 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.
2016-02-18 10:41:47 +00:00
```
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.
2016-05-23 19:37:17 +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
```
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
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)
2016-03-23 12:49:20 +00:00
##### 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
<!---
added note about ansible-config to issue template
2017-09-18 16:32:19 +00:00
If using Ansible 2.4 or above, paste the results of "ansible-config dump --only-changed"
Otherwise, 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
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)
2016-03-23 12:49:20 +00:00
##### OS / 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
<!---
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)
2016-03-23 12:49:20 +00:00
Mention 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
2017-09-18 17:41:17 +00:00
managing, or say "N/A" for anything that is not platform-specific.
Ask for Network OS version info (#25958)
2017-06-21 11:55:55 +00:00
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.
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
-->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
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)
2016-03-23 12:49:20 +00:00
##### SUMMARY
One more improvement
2016-03-23 13:00:55 +00:00
<!--- Explain the problem briefly -->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
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)
2016-03-23 12:49:20 +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
<!---
Remove the hint to report module issue elsewhere.
2016-12-07 08:50:48 +00:00
For bugs, show exactly how to reproduce the problem, using a minimal test-case.
One more improvement
2016-03-23 13:00:55 +00:00
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
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.
2016-05-23 19:37:17 +00:00
<!--- Paste example playbooks or commands between quotes below -->
Remove the hint to report module issue elsewhere.
2016-12-07 08:50:48 +00:00
```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.
2016-05-23 19:37:17 +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
<!--- 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
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)
2016-03-23 12:49:20 +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
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)
2016-03-23 12:49:20 +00:00
##### 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.
2016-05-23 19:37:17 +00:00
<!--- What actually happened? If possible run with extra verbosity (-vvvv) -->
Moving the github issue template file to this repo
2014-09-09 15:59:39 +00:00
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.
2016-05-23 19:37:17 +00:00
<!--- 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.
2016-02-18 10:41:47 +00:00
```
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.
2016-05-23 19:37:17 +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
```
Reference in a new issue Copy permalink