Skip to content

Commit

Permalink
Change issue templates to yaml forms
Browse files Browse the repository at this point in the history
  • Loading branch information
ByteOtter committed Jul 24, 2024
1 parent bc8fdf1 commit ae0a845
Show file tree
Hide file tree
Showing 5 changed files with 172 additions and 64 deletions.
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# SPDX-FileCopyrightText: Christopher Hock and the Nazara Team <[email protected]>
# SPDX-LicenseIdentifier: GPL-3.0-only
---
name: Bug Report
description: Found a bug? Let us know!
title: "[BUG]"
labels: ["bug", "pending"]
body:
- type: markdown
attributes:
value: >
**NOTE**: Please only use this form to report _reproducible bugs_ in Thanix.
If you have any questions or are looking for assistance,
please refer to our [discussion section](https://github.com/orgs/The-Nazara-Project/discussions).
- type: input
attributes:
label: Thanix Version
description: >
Which version of Thanix does this bug affect?
placeholder: master
validations:
required: true
- type: input
attributes:
label: Nazara Version
description: >
Which version of Nazara are you using Thanix' output with (if any).
placeholder: master
- type: input
attributes:
label: NetBox Schema Version
description: >
Which version of NetBox are you running?
placeholder: v4.0.0
- type: input
attributes:
label: openAPI Version
description: The version of openAPI you are using. (In case you are not using NetBox)
placeholder: v3.0
- type: dropdown
attributes:
label: Bug Type
description: >
Which module or area of Thanix does this affect?
multiple: true
options:
- YAML Parsing
- Type Generation
- Path Generation
- Dependencies
- Performance
validations:
required: true
- type: textarea
attributes:
label: Bug Description
description: >
Please describe in detail what issue you face.
validations:
required: true
- type: textarea
attributes:
label: Expected Behaviour
description: >
Please describe what you exepected to happen.
- type: textarea
attributes:
label: Steps to Reproduce
description: >
Please describe what steps we need to take to reproduce this issue.
Please also include any relevant details about your environment (Host system, NetBox Version, etc.)
validations:
required: true
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_change.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# SPDX-FileCopyrightText: Christopher Hock and the Nazara Team <[email protected]>
# SPDX-LicenseIdentifier: GPL-3.0-only
---
name: Documentation Change
description: Suggest a change in Thanix' documentation
labels: ["documentation", "pending"]
body:
- type: dropdown
attributes:
label: Type of Change
description: What kind of change are you proposing?
multiple: false
options:
- Addition
- Correction
- Deprecation
- Maintenance (formatting, typos, grammar, etc.)
validations:
required: true
- type: dropdown
attributes:
label: Section
description: What section do you want to change?
multiple: false
options:
- Installation/Update
- Usage
- Code documentation
- Contribution Guide
- Security Policy
- License
- Other
validations:
required: true
- type: textarea
attributes:
label: Proposed Change
description: Describe your desired change.
validations:
required: true
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# SPDX-FileCopryightText: Christopher Hock and the Nazara Team <[email protected]>
# SPDX-License-Identifier: GPL-3.0-only
---
name: Feature Request
description: Propose a new functionality or feature
title: "[FR]"
labels: ["proposal", "pending"]
body:
- type: markdown
attributes:
value: >
**NOTE**: Please only use this form for submitting _well-formed_ proposals
to extend or enhance Thanix in some form. If you are trying to solve a problem,
or need help bringing your idea inot an actionable form, please use our [discussion section](https://github.com/orgs/The-Nazara-Project/discussions).
- type: input
attributes:
label: Thanix Version
description: What version of Nazara are you working with?
placeholder: master
validations:
required: true
- type: input
attributes:
label: openAPI Version
placeholder: v3.0
- type: dropdown
attributes:
label: Feature Type
multiple: false
options:
- Support for new openAPI version
- Change of Behaviour
- Performance Enhancement
- Maintenance Enhancement
- Usability Enhancement
- Other
validations:
required: true
- type: dropdown
attributes:
label: Affected Module
description: Which module of Nazara will be affected?
multiple: true
options:
- Path Generation
- Type Generation
- CLI Frontend
validations:
required: true
- type: textarea
attributes:
label: Proposal
description: >
Describe your idea in detail. Include any specific requirements
for your plan to work as well as the supposed benefit your feature will bring.
Also include an rough actionplan - if possible.
Feature requests with unclear or missing action plan may take longer to process.
validations:
required: true

0 comments on commit ae0a845

Please sign in to comment.