mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Add other GH Issue forms (#1968)
* Add other GH Issue forms * review comments
This commit is contained in:
parent
5fdbe084e7
commit
f49cf2c22d
4 changed files with 221 additions and 0 deletions
10
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
10
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
@ -125,3 +125,13 @@ body:
|
||||||
```console (paste below)
|
```console (paste below)
|
||||||
|
|
||||||
```
|
```
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Code of Conduct
|
||||||
|
description: |
|
||||||
|
Read the [Ansible Code of Conduct][CoC] first.
|
||||||
|
[CoC]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections
|
||||||
|
options:
|
||||||
|
- label: I agree to follow the Ansible Code of Conduct
|
||||||
|
required: true
|
||||||
|
...
|
||||||
|
|
27
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
27
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
---
|
||||||
|
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
|
||||||
|
blank_issues_enabled: false # default: true
|
||||||
|
contact_links:
|
||||||
|
- name: Security bug report
|
||||||
|
url: https://docs.ansible.com/ansible-core/devel/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
|
||||||
|
about: |
|
||||||
|
Please learn how to report security vulnerabilities here.
|
||||||
|
|
||||||
|
For all security related bugs, email security@ansible.com
|
||||||
|
instead of using this issue tracker and you will receive
|
||||||
|
a prompt response.
|
||||||
|
|
||||||
|
For more information, see
|
||||||
|
https://docs.ansible.com/ansible/latest/community/reporting_bugs_and_features.html
|
||||||
|
- name: Ansible Code of Conduct
|
||||||
|
url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
|
||||||
|
about: Be nice to other members of the community.
|
||||||
|
- name: Talks to the community
|
||||||
|
url: https://docs.ansible.com/ansible/latest/community/communication.html?utm_medium=github&utm_source=issue_template_chooser#mailing-list-information
|
||||||
|
about: Please ask and answer usage questions here
|
||||||
|
- name: Working groups
|
||||||
|
url: https://github.com/ansible/community/wiki
|
||||||
|
about: Interested in improving a specific area? Become a part of a working group!
|
||||||
|
- name: For Enterprise
|
||||||
|
url: https://www.ansible.com/products/engine?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
|
||||||
|
about: Red Hat offers support for the Ansible Automation Platform
|
113
.github/ISSUE_TEMPLATE/documentation_report.yml
vendored
Normal file
113
.github/ISSUE_TEMPLATE/documentation_report.yml
vendored
Normal file
|
@ -0,0 +1,113 @@
|
||||||
|
---
|
||||||
|
name: Documentation Report
|
||||||
|
description: Ask us about docs
|
||||||
|
# NOTE: issue body is enabled to allow screenshots
|
||||||
|
issue_body: true # 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.*
|
||||||
|
|
||||||
|
[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, add suggestions to wording or structure.
|
||||||
|
|
||||||
|
**HINT:** Did you know the documentation has an `Edit on GitHub` link on every page?
|
||||||
|
placeholder: >-
|
||||||
|
I was reading the Collection documentation of version X and I'm having
|
||||||
|
problems understanding Y. It would be very helpful if that got
|
||||||
|
rephrased as Z.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: Issue Type
|
||||||
|
# FIXME: Once GitHub allows defining the default choice, update this
|
||||||
|
options:
|
||||||
|
- Documentation Report
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Component Name
|
||||||
|
description: >-
|
||||||
|
Write the short name of the rst file, module, plugin, task or
|
||||||
|
feature below, *use your best guess if unsure*.
|
||||||
|
placeholder: mysql_user
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Ansible Version
|
||||||
|
description: >-
|
||||||
|
Paste verbatim output from `ansible --version` between
|
||||||
|
tripple backticks.
|
||||||
|
value: |
|
||||||
|
```console (paste below)
|
||||||
|
$ ansible --version
|
||||||
|
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Configuration
|
||||||
|
description: >-
|
||||||
|
Paste verbatim output from `ansible-config dump --only-changed` between quotes.
|
||||||
|
value: |
|
||||||
|
```console (paste below)
|
||||||
|
$ ansible-config dump --only-changed
|
||||||
|
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: OS / Environment
|
||||||
|
description: >-
|
||||||
|
Provide all relevant information below, e.g. OS version,
|
||||||
|
browser, etc.
|
||||||
|
placeholder: Fedora 33, Firefox etc.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional Information
|
||||||
|
description: |
|
||||||
|
Describe how this improves the documentation, e.g. before/after situation or screenshots.
|
||||||
|
|
||||||
|
**Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them.
|
||||||
|
|
||||||
|
**HINT:** You can paste https://gist.github.com links for larger files.
|
||||||
|
placeholder: >-
|
||||||
|
When the improvement is applied, it makes it more straightforward
|
||||||
|
to understand X.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Code of Conduct
|
||||||
|
description: |
|
||||||
|
Read the [Ansible Code of Conduct][CoC] first.
|
||||||
|
[CoC]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections
|
||||||
|
options:
|
||||||
|
- label: I agree to follow the Ansible Code of Conduct
|
||||||
|
required: true
|
||||||
|
...
|
71
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
71
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
@ -0,0 +1,71 @@
|
||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
description: Suggest an idea for this project
|
||||||
|
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.*
|
||||||
|
|
||||||
|
[issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
|
||||||
|
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: Describe the new feature/improvement briefly below.
|
||||||
|
placeholder: >-
|
||||||
|
I am trying to do X with the collection from the main branch on GitHub and
|
||||||
|
I think that implementing a feature Y would be very helpful for me and
|
||||||
|
every other user of ansible-core because of Z.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: Issue Type
|
||||||
|
# FIXME: Once GitHub allows defining the default choice, update this
|
||||||
|
options:
|
||||||
|
- Feature Idea
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Component Name
|
||||||
|
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: Additional Information
|
||||||
|
description: |
|
||||||
|
Describe how the feature would be used, why it is needed and what it would solve.
|
||||||
|
|
||||||
|
**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: false
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Code of Conduct
|
||||||
|
description: |
|
||||||
|
Read the [Ansible Code of Conduct][CoC] first.
|
||||||
|
[CoC]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections
|
||||||
|
options:
|
||||||
|
- label: I agree to follow the Ansible Code of Conduct
|
||||||
|
required: true
|
||||||
|
...
|
Loading…
Reference in a new issue