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

bug_report issue form (#1966)

* Bring inline with ansible/ansible's issue template.
* Add more placeholders
This commit is contained in:
John R Barker 2021-03-04 12:06:25 +00:00 committed by GitHub
parent ac95ff5b45
commit e9866a2ccd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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
- 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
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: textarea
[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'
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: dropdown
- type: dropdown
attributes:
# FIXME: Once GitHub allows defining the default choice, update this
label: Issue Type
# FIXME: Once GitHub allows defining the default choice, update this
options:
- Bug Report
validations:
required: true
- type: textarea
- 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
label: Component Name
description: 'List the component, ie `template`, `mysql_users`'
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
- type: textarea
attributes:
label: Ansible Version
description: |
Paste verbatim output from `ansible --version` between quotes
description: >-
Paste verbatim output from `ansible --version` between
tripple backticks.
value: |
```paste below
```console (paste below)
$ ansible --version
```
- type: textarea
validations:
required: true
- type: textarea
attributes:
label: Configuration
description: |
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
```console (paste below)
$ ansible-config dump --only-changed
```
- type: textarea
- type: textarea
attributes:
label: OS / Environment
description: 'Provide all relevant information below, e.g. target OS versions, network device firmware, etc'
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
- type: textarea
attributes:
label: Steps To Reproduce
description: 'Describe exactly how to reproduce the problem, using a minimal test-case'
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 below
<!--- Paste example playbooks or commands between quotes below -->
```yaml (paste below)
```
- type: textarea
validations:
required: true
- type: textarea
attributes:
label: Expected Results
description: |
Describe what you expected to happen when running the steps above
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
- type: textarea
attributes:
label: Actual Results
description: 'Describe what actually happened. If possible run with extra verbosity (`ansible-playbook -vvvv`)'
description: |
Describe what actually happened. If possible run with extra verbosity (`-vvvv`).
Paste verbatim command output between quotes.
value: |
```paste below
```console (paste below)
```