Merge DEPR automation workflow

docs: Add description to temporary .github/ISSUE_TEMPLATE files
openedx · Apr 4, 2022 · 6f24847 · 6f24847
2 parents 0dd8789 + 8d0177b
commit 6f24847
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git 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
@@ -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]: <Technology Name>"