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

51 lines
1.2 KiB
Markdown
Raw Normal View History

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 13:49:20 +01:00
<!--- Verify first that your issue/request is not already reported in GitHub -->
Moving the github issue template file to this repo
2014-09-09 17:59:39 +02: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 13:49:20 +01:00
##### ISSUE TYPE
<!--- 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 04:23:40 +01:00
- Bug Report
- Feature Idea
- Documentation Report
Moving the github issue template file to this repo
2014-09-09 17:59:39 +02: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 13:49:20 +01:00
##### ANSIBLE VERSION
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01: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 13:49:20 +01:00
<!--- Paste verbatim output from “ansible --version” between quotes -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01:00
```
Moving the github issue template file to this repo
2014-09-09 17:59:39 +02: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 13:49:20 +01: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 12:15:24 +01: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 13:49:20 +01:00
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 04:23:40 +01: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 12:15:24 +01:00
-->
Config might be important for issues.
2015-05-08 00:24:33 +02: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 13:49:20 +01: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 12:15:24 +01: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 13:49:20 +01:00
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 12:15:24 +01: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 17:59:39 +02: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 13:49:20 +01:00
##### SUMMARY
One more improvement
2016-03-23 14:00:55 +01:00
<!--- Explain the problem briefly -->
Moving the github issue template file to this repo
2014-09-09 17:59:39 +02: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 13:49:20 +01: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 12:15:24 +01:00
<!---
One more improvement
2016-03-23 14:00:55 +01:00
For bugs, 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 12:15:24 +01: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 04:23:40 +01:00
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01: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 13:49:20 +01:00
<!--- Paste example playbooks or commands between quotes -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01: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 12:15:24 +01:00
<!--- You can also paste gist.github.com links for larger files -->
Moving the github issue template file to this repo
2014-09-09 17:59:39 +02: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 13:49:20 +01: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 12:15:24 +01:00
<!--- What did you expect to happen when running the steps above? -->
Moving the github issue template file to this repo
2014-09-09 17:59:39 +02: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 13:49:20 +01:00
##### ACTUAL RESULTS
added note for verbosity
2016-02-25 01:21:43 +01:00
<!--- What actually happened? If possible run with high verbosity (-vvvv) -->
Moving the github issue template file to this repo
2014-09-09 17:59:39 +02:00
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01: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 13:49:20 +01:00
<!--- Paste verbatim command output between quotes -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01:00
```
Copy permalink