From 8d0177b5128bffb695043d83d834666ba35e0989 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Mon, 4 Apr 2022 18:30:32 -0400 Subject: [PATCH] docs: Add description to temporary .github/ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE/config.yml | 7 +++++++ .github/ISSUE_TEMPLATE/depr-ticket.yml | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 741cb2ef4..7f11af5d3 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,3 +1,10 @@ +## This configuration file overrides the inherited configuration file defined +## in openedx/.github/.github/ISSUE_TEMPLATE because this repo currently does +## not have Issues turned on, so we create this override to *only* show DEPR +## issues to users creating Issues. Once Issues are turned on and the repo is +## ready to accept Issues of all types, this file must be deleted so inheritance +## of standard openedx configuration works properly. + blank_issues_enabled: false contact_links: - name: Open edX Community Support diff --git a/.github/ISSUE_TEMPLATE/depr-ticket.yml b/.github/ISSUE_TEMPLATE/depr-ticket.yml index 977564ee4..93251af42 100644 --- a/.github/ISSUE_TEMPLATE/depr-ticket.yml +++ b/.github/ISSUE_TEMPLATE/depr-ticket.yml @@ -1,3 +1,10 @@ +## This configuration file overrides the inherited configuration file defined +## in openedx/.github/.github/ISSUE_TEMPLATE because this repo currently does +## not have Issues turned on, so we create this override to *only* show DEPR +## issues to users creating Issues. Once Issues are turned on and the repo is +## ready to accept Issues of all types, this file must be deleted so inheritance +## of standard openedx configuration works properly. + name: Deprecation (DEPR) Ticket description: Per OEP-21, use this template to begin the technology deprecation process. title: "[DEPR]: "