Skip to content

Commit

Permalink
Clean up GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremystretch committed Nov 14, 2024
1 parent 232327d commit 01f044f
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/01-feature_request.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ✨ Feature Request
description: Propose a new NetBox feature or enhancement
description: Propose a new feature or enhancement
labels: ["type: feature"]
body:
- type: input
Expand All @@ -13,21 +13,21 @@ body:
attributes:
label: Proposed functionality
description: >
Describe in detail the new feature or behavior you are proposing. Include any specific changes
to work flows, data models, and/or the user interface. The more detail you provide here, the
greater chance your proposal has of being discussed.
Describe in detail the new feature or behavior you are proposing. Include any specific changes to work flows,
data models, and/or the user interface. 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 functionality would benefit users. What need does it address?
Explain how adding this functionality would benefit users. What specific need(s) does it address?
validations:
required: true
- type: textarea
attributes:
label: External dependencies
description: >
List any new dependencies on external libraries or services that this new feature would
introduce. For example, does the proposal require the installation of a new Python package?
List any new dependencies on external libraries or services that this new feature would introduce. For example,
does the proposal require the installation of a new Python package?
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/02-bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ body:
attributes:
label: Steps to Reproduce
description: >
Describe in detail the exact steps that someone else can take to reproduce
this bug. A numbered list of discrete steps is strongly preferred. Remember
to capture the creation of any objects which must exist to reproduce the
Describe in detail the exact steps that someone else can take to reproduce this bug. A numbered list of discrete
steps is strongly preferred. Remember to capture the creation of any objects which must exist to reproduce the
behavior.
placeholder: |
1. Click on "create widget"
Expand All @@ -45,7 +44,7 @@ body:
- type: textarea
attributes:
label: Observed Behavior
description: What happened instead?
description: What happened instead? Be sure to include any error messages.
placeholder: A TypeError exception was raised
validations:
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/03-documentation_change.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ body:
- type: textarea
attributes:
label: Proposed Changes
description: Describe the proposed changes and why they are necessary.
description: Describe the proposed changes and explain why they are necessary.
validations:
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/04-housekeeping.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 🏡 Housekeeping
description: A change pertaining to the codebase itself (developers only)
description: An internal change pertaining to the codebase itself
labels: ["type: housekeeping"]
body:
- type: textarea
Expand Down

0 comments on commit 01f044f

Please sign in to comment.