diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md new file mode 100644 index 00000000..878c0aaa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank-issue.md @@ -0,0 +1,10 @@ +--- +name: 📝 Blank Issue +about: Record an established issue relating to this repository. In order to increase the likelihood of getting a reponse, we highly recommend cross-posting the issue to the community forum (linked below). +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..cd0ffef3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +# We have our own custom "Blank" template at +# .github/ISSUE_TEMPLATE/blank-issue.md, +# so no need to enable blank issues here. +blank_issues_enabled: false +contact_links: + - name: 💬 Open edX Community Support + url: https://discuss.openedx.org/ + about: Please ask all questions, suggest all enhancements, and report all bugs on the community forum. diff --git a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml new file mode 100644 index 00000000..f4ad6318 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml @@ -0,0 +1,67 @@ +name: 🚅 Fast-Track Deprecation/Removal (DEPR) +description: Announce a pre-approved breaking change. These include planned upgrade tasks, removal of unreachable code, and subtasks of other approved DEPR tickets. Consult the DEPR Working Group if unsure. +title: "[DEPR]: " +labels: ["DEPR"] +body: + - type: markdown + attributes: + value: | + Use this template to announce a pre-accepted breaking change. These include planned upgrade tasks, removal of unreachable code, and subtasks of other accepted DEPR tickets. + + The standard DEPR process is described in [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html). This ticket is using the new ["Fast Track" process]((https://github.com/openedx/.github/issues/175)), which means it gets to skip the RFC (Request for Comments) period. After creating an issue using this template, you do not need to make forum post announcing the RFC period. Instead, **update the issue's status to "Transition Unblocked", and paste the issue link in `#cc-risky-changes` in order to warn site operators.** Once your chosen Breaking Change Unblocked date has passed, you are clear to make the breaking change. + + Please leave [DEPR] in the title of your ticket! + - type: input + id: rfc-start-date + attributes: + label: RFC Start Date + description: Fast-Track Deprecations do not have a comment period. **Leave this unchanged!** + value: N/A -- Already Accepted + validations: + required: true + - type: input + id: accept-date + attributes: + label: Target Plan Accepted Date + description: Fast-Track Deprecations are pre-Accepted. **Leave this unchanged!** + value: N/A -- Already Accepted + validations: + required: true + - type: input + id: transition-unblocked-date + attributes: + label: Target Transition Unblocked Date + description: When can operators prepare for the breaking change? For Fast-Track Deprecations, this generally should be "Immediately". **If not, please specify.** + value: "Immediately -- Transition Already Unblocked" + validations: + required: true + - type: input + id: breaking-change-unblocked-date + attributes: + label: Earliest Breaking Changes Unblocked Date + description: When is the earliest date you may make breaking changes? A good default is 2 weeks from the Transition Unblocked Date, giving operators time to transition. + placeholder: "2026-01-14" + validations: + required: true + - type: textarea + id: rationale + attributes: + label: Rationale + description: Explain, briefly, why this breaking change needs to happen. Because you are fast-tracking this, please link to supporting information, such as an upgrade plan. + validations: + required: true + - type: textarea + id: removal + attributes: + label: Description + description: What functionality is being removed? What functionality, if any, replaces it? How can operators transition? + validations: + required: true + - type: textarea + id: removal-tasks + attributes: + label: Task List + description: (Optional) A list of tasks or PRs to complete this + placeholder: "- [ ] Task 1" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/depr-ticket.yml b/.github/ISSUE_TEMPLATE/depr-ticket.yml new file mode 100644 index 00000000..5e048c82 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/depr-ticket.yml @@ -0,0 +1,105 @@ +name: 🌘 Standard Deprecation/Removal (DEPR) +description: Per OEP-21, use this template to begin the technology deprecation process. +title: "[DEPR]: " +labels: ["DEPR"] +body: + - type: markdown + attributes: + value: | + Refer to [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more detail on the deprecation and removal process. This ticket should only be used for proposing the removal of an Open edX technology. + Please leave [DEPR] in the title of your ticket! + - type: input + id: rfc-start-date + attributes: + label: RFC Start Date + description: The start date of the RFC (Request for Comments). Use the day you will announce this DEPR ticket on discourse (possibly today). + placeholder: "2026-01-15" + validations: + required: true + - type: input + id: accept-date + attributes: + label: Target Plan Accepted Date + description: When is the target date for getting the proposal reviewed and accepted? A good default is approximately 2 weeks from the RFC Start Date (see [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html)). + placeholder: "2026-01-29" + validations: + required: true + - type: input + id: transition-unblocked-date + attributes: + label: Target Transition Unblocked Date + description: What is an estimated target date for unblocking operators for their transition tasks in preparation for any final breaking change? Where a replacement is required, the replacement must be ready. See [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more details. + placeholder: "Estimated March or April 2026" + validations: + required: true + - type: input + id: breaking-change-unblocked-date + attributes: + label: Earliest Breaking Changes Unblocked Date + description: When is the earliest date you may make breaking changes? A good default is the later of 6 months after the RFC Start Date, or 1 month after the Target Transition Unblocked Date. This date can be negotiated as part of the RFC process. See [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more details. + placeholder: "2026-07-05, or one month after the ticket moves to Transition Unblocked, whichever comes later." + validations: + required: true + - type: dropdown + id: named-release-without + attributes: + label: Earliest Open edX Named Release with Breaking Changes + description: What is the earliest named release with the breaking changes? Choose the first release cut date after the Earliest Breaking Changes Unblocked Date. Approximate dates are listed below; for exact dates, see the [release schedule](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3613392957/Open+edX+Release+Schedule) or reach out to the Build Test Release working group (#wg-build-test-release in Slack). + options: + - Verawood - 2026-04 + - Willow - 2026-10 + - Xylon - 2027-04 + - Y - 2027-10 + validations: + required: true + - type: textarea + id: rationale + attributes: + label: Rationale + description: Explain, in a few sentences, why this technology should be removed - what's the usage pattern? What's wrong with keeping it around? + validations: + required: true + - type: textarea + id: removal + attributes: + label: Removal + description: Include a description with links to what exactly is being removed. + validations: + required: true + - type: textarea + id: replacement + attributes: + label: Replacement + description: Include a description with links to what this is being replaced by. + validations: + required: true + - type: textarea + id: deprecation + attributes: + label: Deprecation + description: If you plan to mark the code for deprecation, explain how. + validations: + required: false + - type: textarea + id: addl-info + attributes: + label: Additional Info + description: If there is any additional publicly sharable information or data from your earlier analysis, include that. Will there need to be any manual database migrations needed, for example? + validations: + required: false + - type: textarea + id: transition-unblocked-tasks + attributes: + label: Transition Unblocked Tasks + description: A list of tasks needed to move the ticket to Transition Unblocked. This includes any task required to unblock operators for their transition tasks in preparation for any final breaking change. Where a replacement is required, this includes tasks for completing the replacement. See [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more details. + placeholder: "- [ ] Task 1 needed to deprecate or replace this feature." + validations: + required: false + - type: textarea + id: removal-tasks + attributes: + label: Feature Removal Tasks + description: A list of tasks needed to remove this feature and complete the DEPR. + placeholder: "- [ ] Task 1 needed to remove this feature." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/lti-tool-integration.md b/.github/ISSUE_TEMPLATE/lti-tool-integration.md new file mode 100644 index 00000000..33ab3767 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/lti-tool-integration.md @@ -0,0 +1,13 @@ +--- +name: 🪛 LTI Tool Integration +about: Use this issue type to track the integration, testing, and certification of LTI tools with the Open edX platform. +title: '' +tool url: '' +category: '' +purpose: '' +labels: '' +assignees: '' + +--- + +