summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorSviatoslav Sydorenko <webknjaz@redhat.com>2021-03-03 12:53:33 +0100
committerGitHub <noreply@github.com>2021-03-03 11:53:33 +0000
commitfca85db56a319c032d4ffe4b818b1b37213c6db8 (patch)
treef5ff767769b9e301ccfbcf440a30a7be640a8048 /.github
parent734c0535626ec8a452813c66787df34760615aa3 (diff)
downloadansible-fca85db56a319c032d4ffe4b818b1b37213c6db8.tar.gz
Convert markdown issue templates into issue forms (#73751)
* Convert markdown issue templates into issue forms * Limit allowed issues to the form based ones * Title-case the form field labels Co-authored-by: John R Barker <john@johnrbarker.com> * Remove CoC checkboxes from the forms Co-authored-by: John R Barker <john@johnrbarker.com>
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md54
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml125
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml2
-rw-r--r--.github/ISSUE_TEMPLATE/documentation_report.md38
-rw-r--r--.github/ISSUE_TEMPLATE/documentation_report.yml103
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md25
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml62
7 files changed, 291 insertions, 118 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index a582f76084..0000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,54 +0,0 @@
----
-name: 🐛 Bug report
-about: Create a report to help us improve
----
-<!--- Verify first that your issue is not already reported on GitHub -->
-<!--- Also test if the latest release and devel branch are affected too -->
-<!--- Complete *all* sections as described, this form is processed automatically -->
-
-##### SUMMARY
-<!--- Explain the problem briefly below -->
-
-##### ISSUE TYPE
-- Bug Report
-
-##### COMPONENT NAME
-<!--- Write the short name of the module, plugin, task or feature below, use your best guess if unsure -->
-
-##### ANSIBLE VERSION
-<!--- Paste verbatim output from "ansible --version" between quotes -->
-```paste below
-
-```
-
-##### CONFIGURATION
-<!--- Paste verbatim output from "ansible-config dump --only-changed" between quotes -->
-```paste below
-
-```
-
-##### OS / ENVIRONMENT
-<!--- Provide all relevant information below, e.g. target OS versions, network device firmware, etc. -->
-
-
-##### STEPS TO REPRODUCE
-<!--- Describe exactly how to reproduce the problem, using a minimal test-case -->
-
-<!--- Paste example playbooks or commands between quotes below -->
-```yaml
-
-```
-
-<!--- HINT: You can paste gist.github.com links for larger files -->
-
-##### EXPECTED RESULTS
-<!--- Describe what you expected to happen when running the steps above -->
-
-
-##### ACTUAL RESULTS
-<!--- Describe what actually happened. If possible run with extra verbosity (-vvvv) -->
-
-<!--- Paste verbatim command output between quotes -->
-```paste below
-
-```
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000000..8c80e8e924
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,125 @@
+---
+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.*
+
+ [issue search]: https://github.com/ansible/ansible/search?q=is%3Aissue&type=issues
+
+
+- type: textarea
+ attributes:
+ label: Summary
+ description: Explain the problem briefly below.
+ placeholder: >-
+ When I try to do X with ansible-core from the devel 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
+ attributes:
+ label: Issue Type
+ # FIXME: Once GitHub allows defining the default choice, update this
+ options:
+ - Bug Report
+ 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: Ansible Version
+ description: >-
+ Paste verbatim output from `ansible --version` between
+ tripple backticks.
+ value: |
+ ```console (paste below)
+ $ ansible --version
+
+ ```
+ validations:
+ required: true
+
+- 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: true
+
+- 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: true
+
+
+- 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 and was shocked
+ 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)
+
+ ```
+ validations:
+ required: true
+...
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 239c16431b..74ec5696fd 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
-blank_issues_enabled: true # default
+blank_issues_enabled: false # default: true
contact_links:
- name: 🔐 Security bug report 🔥
url: https://docs.ansible.com/ansible/latest/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser
diff --git a/.github/ISSUE_TEMPLATE/documentation_report.md b/.github/ISSUE_TEMPLATE/documentation_report.md
deleted file mode 100644
index dcb8af67d4..0000000000
--- a/.github/ISSUE_TEMPLATE/documentation_report.md
+++ /dev/null
@@ -1,38 +0,0 @@
----
-name: 📝 Documentation Report
-about: Ask us about docs
----
-<!--- Verify first that your improvement is not already reported on GitHub -->
-<!--- Also test if the latest release and devel branch are affected too -->
-<!--- Complete *all* sections as described, this form is processed automatically -->
-
-##### SUMMARY
-<!--- 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 ? -->
-
-##### ISSUE TYPE
-- Documentation Report
-
-##### COMPONENT NAME
-<!--- Write the short name of the rst file, module, plugin, task or feature below, use your best guess if unsure -->
-
-##### ANSIBLE VERSION
-<!--- Paste verbatim output from "ansible --version" between quotes -->
-```paste below
-
-```
-
-##### CONFIGURATION
-<!--- Paste verbatim output from "ansible-config dump --only-changed" between quotes -->
-```paste below
-
-```
-
-##### OS / ENVIRONMENT
-<!--- Provide all relevant information below, e.g. OS version, browser, etc. -->
-
-##### ADDITIONAL INFORMATION
-<!--- Describe how this improves the documentation, e.g. before/after situation or screenshots -->
-
-<!--- HINT: You can paste gist.github.com links for larger files -->
diff --git a/.github/ISSUE_TEMPLATE/documentation_report.yml b/.github/ISSUE_TEMPLATE/documentation_report.yml
new file mode 100644
index 0000000000..e508c6700b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation_report.yml
@@ -0,0 +1,103 @@
+---
+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/ansible/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 ansible-core 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: docs/docsite/rst/dev_guide/debugging.rst
+ 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: true
+
+- 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: true
+
+- 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: true
+
+- 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: true
+...
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 033d0feb9a..0000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-name: ✨ Feature request
-about: Suggest an idea for this project
----
-<!--- Verify first that your feature was not already discussed on GitHub -->
-<!--- Complete *all* sections as described, this form is processed automatically -->
-
-##### SUMMARY
-<!--- Describe the new feature/improvement briefly below -->
-
-##### ISSUE TYPE
-- Feature Idea
-
-##### COMPONENT NAME
-<!--- Write the short name of the module, plugin, task or feature below, use your best guess if unsure -->
-
-##### ADDITIONAL INFORMATION
-<!--- Describe how the feature would be used, why it is needed and what it would solve -->
-
-<!--- Paste example playbooks or commands between quotes below -->
-```yaml
-
-```
-
-<!--- HINT: You can also paste gist.github.com links for larger files -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000000..757a45c52c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,62 @@
+---
+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/ansible/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 ansible-core from the devel 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 Type
+ 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: true
+...