From ad9ed13b9acfef7003bfa91fc61ad5bacf3fd3bf Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 8 Mar 2021 14:57:42 -0500 Subject: [PATCH] Convert housekeeping and documentation templates to forms --- .../ISSUE_TEMPLATE/documentation_change.md | 28 --------------- .../ISSUE_TEMPLATE/documentation_change.yaml | 34 +++++++++++++++++++ .github/ISSUE_TEMPLATE/housekeeping.md | 16 --------- .github/ISSUE_TEMPLATE/housekeeping.yaml | 23 +++++++++++++ 4 files changed, 57 insertions(+), 44 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation_change.md create mode 100644 .github/ISSUE_TEMPLATE/documentation_change.yaml delete mode 100644 .github/ISSUE_TEMPLATE/housekeeping.md create mode 100644 .github/ISSUE_TEMPLATE/housekeeping.yaml diff --git a/.github/ISSUE_TEMPLATE/documentation_change.md b/.github/ISSUE_TEMPLATE/documentation_change.md deleted file mode 100644 index 9419e0ba9..000000000 --- a/.github/ISSUE_TEMPLATE/documentation_change.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: 📖 Documentation Change -about: Suggest an addition or modification to the NetBox documentation - ---- - - -### Change Type -[ ] Addition -[ ] Correction -[ ] Deprecation -[ ] Cleanup (formatting, typos, etc.) - -### Area -[ ] Installation instructions -[ ] Configuration parameters -[ ] Functionality/features -[ ] REST API -[ ] Administration/development -[ ] Other - - -### Proposed Changes diff --git a/.github/ISSUE_TEMPLATE/documentation_change.yaml b/.github/ISSUE_TEMPLATE/documentation_change.yaml new file mode 100644 index 000000000..28ab16c46 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_change.yaml @@ -0,0 +1,34 @@ +--- +name: 📖 Documentation Change +about: Suggest an addition or modification to the NetBox documentation +labels: ["type: documentation"] +issue_body: false +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: checkboxes + attributes: + label: Area + description: To what section(s) of the documentation does this change pertain? + options: + - label: Installation instructions + - label: Configuration parameters + - label: Functionality/features + - label: REST API + - label: Administration/development + - label: Other + - 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/housekeeping.md b/.github/ISSUE_TEMPLATE/housekeeping.md deleted file mode 100644 index f9ad4142d..000000000 --- a/.github/ISSUE_TEMPLATE/housekeeping.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: 🏡 Housekeeping -about: A change pertaining to the codebase itself (developers only) - ---- - - -### Proposed Changes - - - -### Justification diff --git a/.github/ISSUE_TEMPLATE/housekeeping.yaml b/.github/ISSUE_TEMPLATE/housekeeping.yaml new file mode 100644 index 000000000..26670e288 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/housekeeping.yaml @@ -0,0 +1,23 @@ +--- +name: 🏡 Housekeeping +about: A change pertaining to the codebase itself (developers only) +labels: ["type: housekeeping"] +issue_body: false +body: + - type: markdown + attributes: + value: "**NOTE:** This template is for use by maintainers only. Please do not submit + an issue using this template unless you have been specifically asked to do so." + - type: textarea + attributes: + label: Proposed Changes + description: "Describe in detail the new feature or behavior you'd like to propose. + Include any specific changes to work flows, data models, or the user interface." + validations: + required: true + - type: textarea + attributes: + label: Justification + description: "Please provide justification for the proposed change(s)." + validations: + required: true