From f29d92cd2439a9073053a6dc4a0238f26e237f30 Mon Sep 17 00:00:00 2001 From: Michal Fiedorowicz Date: Mon, 21 Oct 2024 11:21:13 +0100 Subject: [PATCH 1/2] chore: add GitHub issue templates Signed-off-by: Michal Fiedorowicz --- .../ISSUE_TEMPLATE/01-feature_request.yaml | 36 +++++++++++++ .github/ISSUE_TEMPLATE/02-bug_report.yaml | 53 +++++++++++++++++++ .../03-documentation_change.yaml | 35 ++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + 4 files changed, 125 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/02-bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/03-documentation_change.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/01-feature_request.yaml b/.github/ISSUE_TEMPLATE/01-feature_request.yaml new file mode 100644 index 0000000..085b9b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-feature_request.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/02-bug_report.yaml b/.github/ISSUE_TEMPLATE/02-bug_report.yaml new file mode 100644 index 0000000..6c5ad64 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-bug_report.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/03-documentation_change.yaml b/.github/ISSUE_TEMPLATE/03-documentation_change.yaml new file mode 100644 index 0000000..bf6720d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-documentation_change.yaml @@ -0,0 +1,35 @@ +--- +name: 📖 Documentation Change +description: Suggest an addition or modification to the Diode Python SDK 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 diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false From 91910e5fabc814622a24394f8505bec24e3cec43 Mon Sep 17 00:00:00 2001 From: Michal Fiedorowicz Date: Mon, 21 Oct 2024 11:22:50 +0100 Subject: [PATCH 2/2] typo Signed-off-by: Michal Fiedorowicz --- .github/ISSUE_TEMPLATE/03-documentation_change.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/03-documentation_change.yaml b/.github/ISSUE_TEMPLATE/03-documentation_change.yaml index bf6720d..4f34b79 100644 --- a/.github/ISSUE_TEMPLATE/03-documentation_change.yaml +++ b/.github/ISSUE_TEMPLATE/03-documentation_change.yaml @@ -1,6 +1,6 @@ --- name: 📖 Documentation Change -description: Suggest an addition or modification to the Diode Python SDK documentation +description: Suggest an addition or modification to the Diode SDK Python documentation labels: ["documentation", "status: needs triage"] body: - type: dropdown