Skip to content

Commit

Permalink
New Issue and PR Templates (#199)
Browse files Browse the repository at this point in the history
* add codeowners

* updates for issue and pr templates

* address review comments

* update fqcn names

* Update bug_report.yml

Fix FQCN for validate role

* Update documentation_report.yml

Fix FQCN for validate role

* Update feature_request.yml

Fix FQCN for validate role

* Update pull_request_template.md

Fix FQCN for validate role

---------

Co-authored-by: Mike Wiebe <[email protected]>
  • Loading branch information
mtarking and mikewiebe authored Oct 11, 2024
1 parent 467862b commit f57ec00
Show file tree
Hide file tree
Showing 7 changed files with 423 additions and 167 deletions.
73 changes: 0 additions & 73 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

138 changes: 138 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
name: Bug Report
description: Report a bug impacting VXLAN as Code collection
title: Bug Report Title
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for creating a bug issue to help us improve the VXLAN as Code collection.
Please fill out the sections below to help us understand and reproduce the issue you are facing.
- type: markdown
attributes:
value: |
### Community Note
Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
If you are interested in working on this issue or have submitted a pull request, please leave a comment
- type: textarea
id: ansible-version
attributes:
label: Ansible Version
description: Please provide your Ansible version used when encountering this issue
placeholder: ansible --version
render: shell
validations:
required: true

- type: textarea
id: ansible-collection-versions
attributes:
label: Ansible Collection Versions
description: Please provide your Ansible Collection versions used when encountering this issue
placeholder: ansible-galaxy collection list
render: shell
validations:
required: true

- type: textarea
id: ndfc-version
attributes:
label: Cisco NDFC Version
description: Please provide your Cisco NDFC version used when encountering this issue
render: shell
validations:
required: true

- type: textarea
id: nxos-version
attributes:
label: Cisco NX-OS Version
description: Please provide your Cisco NX-OS version used when encountering this issue
render: shell
validations:
required: false

- type: dropdown
id: role
attributes:
label: Which role is this issue related to?
multiple: false
options:
- cisco.nac_dc_vxlan.validate
- cisco.nac_dc_vxlan.dtc.create
- cisco.nac_dc_vxlan.dtc.deploy
- cisco.nac_dc_vxlan.dtc.remove
- other
validations:
required: true

- type: dropdown
id: data-model
attributes:
label: Which section of the data model is this issue related to?
multiple: false
options:
- vxlan.global
- vxlan.topology
- vxlan.underlay
- vxlan.overlay_services
- vxlan.overlay_extensions
- vxlan.policy
- defaults.vxlan
- other
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Please provide the expected behavior
placeholder: Expected behavior
render: shell
validations:
required: false

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: Please provide the actual behavior
placeholder: Actual behavior
render: shell
validations:
required: false

- type: textarea
id: ansible-playbook
attributes:
label: Ansible Playbook
description: Please provide your Ansible playbook that is encountering the issue
placeholder: Ansible Playbook
render: yaml
validations:
required: true

- type: textarea
id: step-to-reproduce
attributes:
label: Steps to Reproduce
description: Please provide the steps to reproduce the issue
placeholder: List of steps to reproduce the issue
render: shell
validations:
required: true

- type: textarea
id: debug-output
attributes:
label: Relevant Debug Output
description: Please copy and paste any relevant log or debug output. This will be automatically formatted into code
placeholder: Relevant log or debug output
render: shell
validations:
required: false
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/documentation_report.md

This file was deleted.

111 changes: 111 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---

name: Documentation Report
description: Report a documentation issue for the VXLAN as Code collection
title: Documentation Report Title
labels:
- documentation
- doc
body:
- type: markdown
attributes:
value: |
Thanks for creating a documentation issue to help us improve the VXLAN as Code collection.
Please fill out the sections below to help us understand and reproduce the issue you are facing.
- type: markdown
attributes:
value: |
### Community Note
Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
If you are interested in working on this issue or have submitted a pull request, please leave a comment
- type: dropdown
id: role
attributes:
label: Which role is the documentation update related?
multiple: false
options:
- cisco.nac_dc_vxlan.validate
- cisco.nac_dc_vxlan.dtc.create
- cisco.nac_dc_vxlan.dtc.deploy
- cisco.nac_dc_vxlan.dtc.remove
- other
validations:
required: true

- type: dropdown
id: data-model
attributes:
label: Which section of the data model is the documentation update related?
multiple: false
options:
- vxlan.global
- vxlan.topology
- vxlan.underlay
- vxlan.overlay_services
- vxlan.overlay_extensions
- vxlan.policy
- defaults.vxlan
- other
validations:
required: true

- type: textarea
id: new-or-affected-documentation
attributes:
label: New or Affected Documentation
description: Please list the new or affected documentation sections
placeholder: Documentation section or new documentation that needs attention
render: shell
validations:
required: true

- type: textarea
id: documentation-description
attributes:
label: Documentation Description
description: Please leave a helpful description of the documentation report here
placeholder: Documentation section or new documentation that needs attention
render: shell
validations:
required: true

- type: textarea
id: ansible-version
attributes:
label: Ansible Version
description: Please provide your Ansible version used when encountering this issue
placeholder: ansible --version
render: shell
validations:
required: false

- type: textarea
id: ansible-collection-versions
attributes:
label: Ansible Collection Versions
description: Please provide your Ansible Collection versions used when encountering this issue
placeholder: ansible-galaxy collection list
render: shell
validations:
required: false

- type: textarea
id: ndfc-version
attributes:
label: Cisco NDFC Version
description: Please provide your Cisco NDFC version used when encountering this issue
render: shell
validations:
required: false

- type: textarea
id: nxos-version
attributes:
label: Cisco NX-OS Version
description: Please provide your Cisco NX-OS version used when encountering this issue
render: shell
validations:
required: false
Loading

0 comments on commit f57ec00

Please sign in to comment.