openedx
/
platform-roadmap
mirror of https://github.com/openedx/platform-roadmap.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #467 from openedx/combine_templates 

feat: new combined template
This commit is contained in:
Sara Burns 2025-10-10 09:57:33 -04:00 committed by GitHub
parent 3f839c75cd bfc10e5629
commit f151296714
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 49 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
.github/ISSUE_TEMPLATE/01-product-contribution.yml vendored Normal file
View File

@ -0,0 +1,49 @@
name: Open edX Product Contribution
description: Choose this to propose any change to the Open edX Platform — from small tweaks to major features that need review and alignment.
title: "Ensure your title is clear and descriptive"
labels: ["product proposal"]
body:
- type: markdown
attributes:
value: |
## Open edX Product Contribution
Use this form to propose any change to the Open edX Platform; from small, low-risk improvements (Fast Track Changes) to larger features (Product Proposals). See the [Product Contribution Guide](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3875962884/How+to+submit+an+open+source+contribution+for+Product+Review) for more detail.
- type: dropdown
id: requesttype
attributes:
label: Type of Request
options:
- Fast Track Change (small, low-risk improvements)
- Product Proposal (larger features)
default: 0
validations:
required: true
- type: textarea
id: featuredesc
attributes:
label: Feature Description
description: What is being proposed? (Copy the TL;DR from your proposal if you have one)
validations:
required: true
- type: input
id: proplink
attributes:
label: Link to Product Proposal
description: "**Required** for Product Proposals - **Optional** for Fast Track Changes"
- type: dropdown
id: status
attributes:
label: Status
options:
- New
- In Review
default: 0
validations:
required: True
- type: input
id: author
attributes:
label: Proposed By
description: Name of provider or organization
validations:
required: true

88
.github/ISSUE_TEMPLATE/01-roadmap-issue.yml vendored
View File

@ -1,88 +0,0 @@
name: Open edX Product Proposal Submission
description: Choose this if you have an idea to propose, with a product proposal, for the Product Group to evaluate for potential addition to the Open edX Roadmap
title: "Put Initiative Name Here"
body:
- type: markdown
attributes:
value: |
## Open edX Product Proposal Submission
This template standardizes a method of representing all _**planned or proposed Initiatives, as well as current, in-flight Initiatives**_ that will be contributed to the Open edX Platform. It is intended to provide a high-level overview of the scope of the work, the approach, the value-add, and the anticipated impact. It should be written in such a way that a newcomer who may be unfamiliar with the Open edX platform can quickly gain an understanding of the “what”, the “why” and the “how” of the Initiative. See https://openedx.atlassian.net/wiki/spaces/COMM/pages/3875962884/How+to+submit+an+open+source+contribution+for+Product+Review for more detail.
- type: textarea
id: abstract
attributes:
label: Abstract
description: Brief summary of the goal of the Initiative and the intended outcome. For example, if the Initiative is intended to fix a problem or pain point, include a problem statement and the proposed solution. If the Initiative is a new feature or an enhancement, include a statement about how the new feature will improve the platform, and for whom the improvements are intended.
validations:
required: true
- type: input
id: proplink
attributes:
label: Detailed Product Proposal
description: Provide a link to your product proposal, if applicable
placeholder: Link to public page on the Open edX wiki
- type: textarea
id: cb
attributes:
label: Context & Background (in brief, if a Product Proposal is linked above)
description: Any relevant background information about the Initiative. What key pieces of information are important for newcomers to understand about the nature of the problem or pain point, the current user experience, etc.
validations:
required: true
- type: textarea
id: sa
attributes:
label: Scope & Approach (in brief, if a Product Proposal is linked above)
description: Outline the scope of the Initiative and a description of how the work is being done. Who is the primary persona, ie the primary beneficiary of this Initiative? If appropriate, please provide links or a description of market research or user feedback/input that has shaped the Initiative. Please include links to design documentation that may be relevant. If the Initiative is in the early Discovery phase, please describe the Discovery method/hypothesis being tested.
validations:
required: true
- type: textarea
id: vi
attributes:
label: Value & Impact (in brief, if a Product Proposal is linked above)
description: Please include the metrics being used to measure success for the Initiative. How will the Open edX platform and/or experience be measurably better than before?
validations:
required: true
- type: textarea
id: me
attributes:
label: Milestones and/or Epics
description: |
Any relevant background information about the Initiative. What key pieces of information are important for newcomers to understand about the nature of the problem or pain point, the current user experience, etc. Please use the following format:
**Milestone 1**: [Title]
* [1-2 sentence abstract. Include key user stories if appropriate]
* [Impact metric]
* [Link to Epic where it may exist in GitHub]
**Milestone 2**: etc...
validations:
required: true
- type: input
id: release
attributes:
label: Named Release
description: First Named Release to include this initiative. Alphabetical named releases are generally cut in early April and early October. Based on the removal date, what named release would be the first without this code? Please reach out to the Build Test Release working group (#wg-build-test-release in Slack) if you're not sure. Use the letter, if you're not sure of the name.
placeholder: Teak
validations:
required: true
- type: textarea
id: time
attributes:
label: Timeline (in brief, if a Product Proposal is linked above)
description: Recognizing that many Initiatives evolve incrementally, please include a brief scope of the Initiative timeline. Please include a target Named Release, with contingencies if necessary.
validations:
required: true
- type: input
id: author
attributes:
label: Proposed By
description: Name of provider/organization
placeholder: Axim
validations:
required: true
- type: textarea
id: addl
attributes:
label: Additional Info
description: Links to external documents (for example, wiki pages, documents, or demos)
validations:
required: false

78
.github/ISSUE_TEMPLATE/02-feature-request.yml vendored
View File

@ -1,78 +0,0 @@
name: Open edX Feature Request
description: Choose this to express interest in an idea not already on the roadmap, that you do not have a proposal for. Creating a new request DOES NOT guarantee prioritization or implementation.
title: "Put Feature Name Here"
body:
- type: markdown
attributes:
value: |
## Open edX Feature Request
Choose this to express interest in an idea not already on the roadmap, that you don't have a proposal for. Please note that creating a new request DOES NOT guarantee prioritization or implementation.
- type: checkboxes
attributes:
label: 1. Is there an existing issue for this?
description: Please search to see if a feature request or roadmap item already exists for this request
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: newfeat
attributes:
label: 2. What new feature or functionality would you like to request?
description: Please be as succinct as possible
validations:
required: true
- type: dropdown
id: area
attributes:
label: 3. What product area does this feature affect?
options:
- Courseware
- Credentials
- Data
- Discussion forums
- docs.openedx.org
- Libraries
- LTI
- MFEs
- Tutor or other developer-facing
- Ecommerce/course marketing
- Studio
- LMS (not listed above)
- Other
validations:
required: true
- type: textarea
id: scope
attributes:
label: 4. Please describe the scope of the feature
description: In 1 - 2 sentences, what area(s) of the platform does this feature affect?
validations:
required: true
- type: textarea
id: need
attributes:
label: 5. Please describe why you see a need for this feature
description: In 1 - 2 sentences, describe who would use this feature. Why is this unique from existing features? Please cite market data where possible.
validations:
required: true
- type: textarea
id: vi
attributes:
label: 6. Please describe the potential impact and/or value of this feature
description: Describe succinctly (1-2 sentences) how this provides value to the Open edX community
validations:
required: true
- type: textarea
id: usec
attributes:
label: 7. Please provide 2-3 use cases and/or user stories in support of this feature
description: If you'd like examples of how to write user stories, see [these example stories](https://docs.google.com/spreadsheets/d/1-SKV33_IdzNxESTTIQeerlN6FyGeqXgLE3tqebsxOGk/edit#gid=1959183385)
validations:
required: true
- type: textarea
id: addl
attributes:
label: 8. Any additional information you'd like to provide?
description: Links to external documents (for example, wiki pages, documents, or demos)
validations:
required: false