diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e7d5579433..24061f6028 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,86 +1,127 @@ -name: Bug Report -about: Create a report to help us improve +--- +name: Bug report +description: Create a report to help us improve +issue_body: false # default: true, adds a classic WSYWIG textarea, if on body: +- type: markdown + attributes: + value: | + ⚠ + Verify first that your issue is not [already reported on GitHub][issue search]. + Also test if the latest release and devel branch are affected too. + *Complete **all** sections as described, this form is processed automatically.* - - type: markdown - attributes: - value: | - Verify first that your issue is not already reported on [GitHub](https://github.com/ansible-collections/community.general/issues) - Also test if the latest release and main branch are affected too + [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues - - type: textarea - attributes: - label: Summary - description: 'Explain the problem briefly below' - validations: - required: true - - type: dropdown - attributes: - # FIXME: Once GitHub allows defining the default choice, update this - label: Issue Type - options: - - Bug Report - validations: - required: true +- type: textarea + attributes: + label: Summary + description: Explain the problem briefly below. + placeholder: >- + When I try to do X with the collection from the main branch on GitHub, Y + breaks in a way Z under the env E. Here are all the details I know + about this problem... + validations: + required: true - - type: textarea - attributes: - # For smaller collections we could use a multi-select and hardcode the list - # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins - # Select from list, filter as you type (`mysql` would only show the 3 mysql components) - # OR freeform - doesn't seem to be supported in adaptivecards +- type: dropdown + attributes: + label: Issue Type + # FIXME: Once GitHub allows defining the default choice, update this + options: + - Bug Report + validations: + required: true - label: Component Name - description: 'List the component, ie `template`, `mysql_users`' - validations: - required: true +- type: textarea + attributes: + # For smaller collections we could use a multi-select and hardcode the list + # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins + # Select from list, filter as you type (`mysql` would only show the 3 mysql components) + # OR freeform - doesn't seem to be supported in adaptivecards - - type: textarea - attributes: - label: Ansible Version - description: | - Paste verbatim output from `ansible --version` between quotes - value: | - ```paste below + description: >- + Write the short name of the module, plugin, task or feature below, + *use your best guess if unsure*. + placeholder: dnf, apt, yum, pip, user etc. + validations: + required: true - ``` - - type: textarea - attributes: - label: Configuration - description: | - If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. - This can be a piece of YAML from, e.g., an automation, script, scene or configuration. - Paste verbatim output from `ansible-config dump --only-changed` between quotes - value: | - ```paste below +- type: textarea + attributes: + label: Ansible Version + description: >- + Paste verbatim output from `ansible --version` between + tripple backticks. + value: | + ```console (paste below) + $ ansible --version - ``` - - type: textarea - attributes: - label: OS / Environment - description: 'Provide all relevant information below, e.g. target OS versions, network device firmware, etc' + ``` + validations: + required: true - - type: textarea - attributes: - label: Steps To Reproduce - description: 'Describe exactly how to reproduce the problem, using a minimal test-case' - value: | - ```paste below +- type: textarea + attributes: + label: Configuration + description: >- + If this issue has an example piece of YAML that can help to reproduce this problem, please provide it. + This can be a piece of YAML from, e.g., an automation, script, scene or configuration. + Paste verbatim output from `ansible-config dump --only-changed` between quotes + value: | + ```console (paste below) + $ ansible-config dump --only-changed - ``` - - type: textarea - attributes: - label: Expected Results - description: | - Describe what you expected to happen when running the steps above + ``` - - type: textarea - attributes: - label: Actual Results - description: 'Describe what actually happened. If possible run with extra verbosity (`ansible-playbook -vvvv`)' - value: | - ```paste below - ``` +- type: textarea + attributes: + label: OS / Environment + description: >- + Provide all relevant information below, e.g. target OS versions, + network device firmware, etc. + placeholder: RHEL 8, CentOS Stream etc. + validations: + required: false + + +- type: textarea + attributes: + label: Steps to Reproduce + description: | + Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also pased any playbooks, configs and commands you used. + + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + <!--- Paste example playbooks or commands between quotes below --> + ```yaml (paste below) + + ``` + validations: + required: true + +- type: textarea + attributes: + label: Expected Results + description: >- + Describe what you expected to happen when running the steps above. + placeholder: >- + I expected X to happen because I assumed Y. + that it did not. + validations: + required: true + +- type: textarea + attributes: + label: Actual Results + description: | + Describe what actually happened. If possible run with extra verbosity (`-vvvv`). + + Paste verbatim command output between quotes. + value: | + ```console (paste below) + + ```