Skip to content

docs: cbe competency rule profile adr amendments#636

Open
mgwozdz-unicon wants to merge 2 commits into
openedx:mainfrom
mgwozdz-unicon:cbe-competency-rule-profile-adr-amendments
Open

docs: cbe competency rule profile adr amendments#636
mgwozdz-unicon wants to merge 2 commits into
openedx:mainfrom
mgwozdz-unicon:cbe-competency-rule-profile-adr-amendments

Conversation

@mgwozdz-unicon

Copy link
Copy Markdown
Contributor

Claude assisted...

Summary

Amends ADR 0002 (competency criteria model) and ADR 0003 (versioning) to close gaps in the CompetencyRuleProfile design in this Slack thread: https://openedx.slack.com/archives/C09A1BN1CSE/p1783010474048009

Changes

ADR 0002

  • CompetencyRuleProfile scope fields (organization_id, course_id, competency_taxonomy_id) are now consistently nullable, at most one populated per row; combining more than one on a single profile is explicitly out of scope for now (documented as a new Rejected Alternative, since a required-parent-scope hierarchy was considered and doesn't fit taxonomies that span multiple organizations).
  • Added a unique constraint on the scope-column index, so at most one profile can exist per distinct scope combination.
  • Added CompetencyTaxonomy.taxonomy_overrides_org, a boolean (default false) that breaks the tie when both an organization-scoped and a taxonomy-scoped profile could apply to the same criterion.
  • Rewrote how CompetencyCriterion.competency_rule_profile_id gets assigned: it's recomputed at several explicit trigger points (creation, a more specific profile appearing later, a per-criterion override being set, an override being cleared back to the default) rather than resolved dynamically at evaluation time. Added the resolution-order tables (by which profile rows exist) and the org/taxonomy tiebreak table directly to the ADR.
  • CompetencyRuleProfile is now never hard-deleted, even pre-use (a carve-out from the general delete-protection rule) — retirement is archive-only via a new archived column. Editing is restricted to rule_type/rule_payload; scope fields are immutable after creation.
  • Corrected the Grade rule payload example to the platform's actual fractional grade scale (0.0–1.0, not 0–100), and specified the allowed op values (gte, lte, eq).

ADR 0003

  • Decision 4 now defines "in use" for a CompetencyRuleProfile explicitly, and extends the existing edit-warning requirement to cover profile reassignment and override-state switching, not just direct edits.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 3, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @mgwozdz-unicon!

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants