Skip to content

docs: add ADR proposing to reference course scopes by course key - #625

Draft
mariajgrimaldi wants to merge 1 commit into
mainfrom
MJG/coursescope-key-adr
Draft

mariajgrimaldi wants to merge 1 commit into
mainfrom
MJG/coursescope-key-adr

Conversation

@mariajgrimaldi

@mariajgrimaldi mariajgrimaldi commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

Description

Migration 0007_coursescope fails with MySQL error 3780 when the platform's course table doesn't use utf8mb4_unicode_ci (#593). #626 fixes the migration, but the foreign key from CourseScope to the platform's CourseOverview stays, and with it a dependency on how openedx-platform models courses, although course scopes already store their course key in Scope.external_key.

ADR 0035 proposes referencing course scopes only by that key, with a read-only course_overview property, a post_delete receiver that deletes the scope and its role assignments with the course, and a migration that copies older keys into external_key and removes the column, which #627 implements. Content library scopes keep their foreign key, and a dated addendum to ADR 0005 points to the new ADR.

Related to #593.

Testing instructions

Docs only, rendered in ADR 0035 on Read the Docs.

Merge checklist:
Check off if complete or not applicable:

  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@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 Nov 16, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Nov 16, 2026
@mariajgrimaldi mariajgrimaldi changed the title MJG/coursescope key adr docs: ADR 0035 - Reference Course Scopes by Course Key Nov 16, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Nov 16, 2026
@mariajgrimaldi mariajgrimaldi changed the title docs: ADR 0035 - Reference Course Scopes by Course Key docs: add ADR proposing to reference course scopes by course key Nov 18, 2026
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/coursescope-key-adr branch from 4f9d95a to e858d65 Compare November 18, 2026 12:45
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: Waiting on Author

Development

Successfully merging this pull request may close these issues.

2 participants