Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add GitHub issue templates #20

Merged
merged 2 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/01-feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: ✨ Feature Request
description: Propose a new Diode SDK Python feature or enhancement
labels: ["enhancement", "status: needs triage"]
body:
- type: input
attributes:
label: Diode SDK Python version
description: What version of Diode SDK Python are you currently running?
placeholder: v0.4.0
validations:
required: true
- type: dropdown
attributes:
label: Feature type
options:
- New ingestion entity type or new field of existing entity type
- New functionality
- Change to existing functionality
validations:
required: true
- type: textarea
attributes:
label: Proposed feature or enhancement
description: >
Describe in detail the new feature or enhancement you are proposing. The more detail you provide here,
the greater chance your proposal has of being discussed.
validations:
required: true
- type: textarea
attributes:
label: Use case
description: >
Explain how adding this feature or enhancement would benefit Diode users. What need does it address?
validations:
required: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/02-bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: 🐛 Bug Report
description: Report a reproducible bug in the current release of Diode SDK Python
labels: ["bug", "status: needs triage"]
body:
- type: input
attributes:
label: Diode SDK Python version
description: What version of Diode SDK Python are you currently running?
placeholder: v0.4.0
validations:
required: true
- type: input
attributes:
label: Diode version
description: What version of Diode are you currently running?
placeholder: v0.6.0
validations:
required: true
- type: input
attributes:
label: Diode NetBox Plugin version
description: What version of Diode NetBox Plugin are you currently running?
placeholder: v0.6.0
validations:
required: true
- type: input
attributes:
label: NetBox version
description: What version of NetBox are you currently running?
placeholder: v4.1.3
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: >
Describe in detail the exact steps that someone else can take to reproduce this bug using given Diode SDK
Python, Diode, Diode NetBox Plugin and NetBox versions.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
attributes:
label: Observed behavior
description: What happened instead?
validations:
required: true
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/03-documentation_change.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: 📖 Documentation Change
description: Suggest an addition or modification to the Diode SDK Python documentation
labels: ["documentation", "status: needs triage"]
body:
- type: dropdown
attributes:
label: Change type
description: What type of change are you proposing?
options:
- Addition
- Correction
- Removal
- Cleanup (formatting, typos, etc.)
validations:
required: true
- type: dropdown
attributes:
label: Area
description: To what section of the documentation does this change primarily pertain?
options:
- Features
- Installation/upgrade
- Getting started
- Configuration
- Development
- Other
validations:
required: true
- type: textarea
attributes:
label: Proposed changes
description: Describe the proposed changes and why they are necessary.
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false