Skip to content

Commit

Permalink
Add issue templates
Browse files Browse the repository at this point in the history
Create issue templates for bugs, docs, and feature requests.
  • Loading branch information
samdoran committed Nov 30, 2021
1 parent 41d0acb commit 397033a
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 0 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,79 @@
name: Bug report
description: Report a problem so it can be fixed
labels:
- needs_triage

body:
- type: markdown
attributes:
value: |
**Thank you for reporting a bug in Ansible Runner.**
If you are looking for community support, please reach out on IRC:
[#ansible](https://web.libera.chat/#ansible)
[#ansible-runner](https://web.libera.chat/#ansible-runner)
- type: input
label: Ansible Runner version
description: Output from `ansible-runner --version`
render: console
validations:
required: true

- type: textarea
label: Python version
description: Output from `python -VV`
render: console
validations:
required: true

- type: textarea
label: Operating System and Environment
description: Provide relevant information about the operating system and environment
render: console
placeholder: RHEL 8, Debian 10, output from `/etc/os-release`, any other relevant information
validations:
required: true

- type: input
label: Container Runtime
description: Output from `podman|docker --version`
render: console
placeholder: podman --version
validations:
required: true

- type: textarea
attributes:
label: Summary
description: Briefly explain the problem
validations:
required: true

- type: textarea
attributes:
label: Steps to reproduce
description: Describe in detail how to reproduce the problem
value: |
1.
2.
3.
validations:
required: true

- type: textarea
attributes:
label: Expected Results
description: What was expected to happen when running the steps above
validations:
required: true

- type: textarea
attributes:
label: Actual Results
description: What actually happened when running the steps above
validations:
required: true


1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
blank_issue_enabled: false
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_report.yml
@@ -0,0 +1,24 @@
name: Documentation Report
description: Report an issue with documentation
labels:
- needs_triage
- docs

body:
- type: markdown
attributes:
value: |
**Thank you reporting an issue with Ansible Runner documentation.**
If you are looking for community support, please reach out on IRC:
[#ansible](https://web.libera.chat/#ansible)
[#ansible-runner](https://web.libera.chat/#ansible-runner)
- type:
attributes:
label: Summary
description: Describe the problem or suggestion with the documentation
validations:
required: true
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,24 @@
name: Feature Request
description: Suggest a new feature
labels:
- needs_triage
- enhancement

body:
- type: markdown
attributes:
value: |
**Thank you for suggesting a new feature for Ansible Runner.**
If you are looking for community support, please reach out on IRC:
[#ansible](https://web.libera.chat/#ansible)
[#ansible-runner](https://web.libera.chat/#ansible-runner)
- type:
attributes:
label: Summary
description: Describe the new feature and how it would be used.
validations:
required: true

0 comments on commit 397033a

Please sign in to comment.