Skip to content

feat: typed PK identifiers for Units/Subsections/Sections#535

Merged
bradenmacdonald merged 1 commit intobraden/typed-pksfrom
braden/typed-pks-units
Apr 8, 2026
Merged

feat: typed PK identifiers for Units/Subsections/Sections#535
bradenmacdonald merged 1 commit intobraden/typed-pksfrom
braden/typed-pks-units

Conversation

@bradenmacdonald
Copy link
Copy Markdown
Contributor

This is an optional extension to #534 which further breaks Container.PK down into Unit.PK, Subsection.PK, Section.PK key types.

For now it works smoothly and has a very small diff to implement. But I am worried that it could add more complexity (and require more casting) than it's worth down the road? Hard to say. Since we don't have much difference between the container types at the moment, I'm not sure what the trade-offs are here.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Apr 8, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@kdmccormick
Copy link
Copy Markdown
Member

Looks good to me 👍🏻

(If we end up finding the casting too cumbersome, then I think that's an indication that the container subclass models shouldn't exist.)

@bradenmacdonald bradenmacdonald force-pushed the braden/typed-pks-units branch from 7c4354a to 37f9721 Compare April 8, 2026 21:32
@bradenmacdonald bradenmacdonald merged commit 37f9721 into braden/typed-pks Apr 8, 2026
1 check passed
@bradenmacdonald bradenmacdonald deleted the braden/typed-pks-units branch April 8, 2026 21:33
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Apr 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants