From ce6d8e836afbb7479510fb7214791d85a136bd6a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 14 Nov 2024 15:45:51 -0500 Subject: [PATCH] Clean up GitHub issue templates --- .github/ISSUE_TEMPLATE/01-feature_request.yaml | 14 +++++++------- .github/ISSUE_TEMPLATE/02-bug_report.yaml | 7 +++---- .../ISSUE_TEMPLATE/03-documentation_change.yaml | 2 +- .github/ISSUE_TEMPLATE/04-housekeeping.yaml | 2 +- 4 files changed, 12 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-feature_request.yaml b/.github/ISSUE_TEMPLATE/01-feature_request.yaml index 6c594b7..1bff827 100644 --- a/.github/ISSUE_TEMPLATE/01-feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/01-feature_request.yaml @@ -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 @@ -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? diff --git a/.github/ISSUE_TEMPLATE/02-bug_report.yaml b/.github/ISSUE_TEMPLATE/02-bug_report.yaml index a085f62..7117388 100644 --- a/.github/ISSUE_TEMPLATE/02-bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/02-bug_report.yaml @@ -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" @@ -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 diff --git a/.github/ISSUE_TEMPLATE/03-documentation_change.yaml b/.github/ISSUE_TEMPLATE/03-documentation_change.yaml index 9f7968e..f9489e5 100644 --- a/.github/ISSUE_TEMPLATE/03-documentation_change.yaml +++ b/.github/ISSUE_TEMPLATE/03-documentation_change.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/04-housekeeping.yaml b/.github/ISSUE_TEMPLATE/04-housekeeping.yaml index cec1500..c8b3de5 100644 --- a/.github/ISSUE_TEMPLATE/04-housekeeping.yaml +++ b/.github/ISSUE_TEMPLATE/04-housekeeping.yaml @@ -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