Skip to content

docs: add ADR for authorization schema source tracking - #444

Open
rodmgwgu wants to merge 1 commit into
mainfrom
rod/authz-schema-adr
Open

docs: add ADR for authorization schema source tracking#444
rodmgwgu wants to merge 1 commit into
mainfrom
rod/authz-schema-adr

Conversation

@rodmgwgu

@rodmgwgu rodmgwgu commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Problem

The authorization schema loading pipeline needs a documented decision record explaining how schema definitions and their source are tracked before the implementation lands.

Approach

Adds ADR 0025-authorization-schema-source-tracking.rst describing the source-tracking design.

AI Usage

Kiro was used to assist on research and write the ADR with human guidance and validation.


Stack (1/3) — split from a single combined commit for reviewability:

  1. This PR — ADR doc (base: main)
  2. rod/authz-schema-files — authz schema YAML files (base: this branch)
  3. rod/authz-schema-loader — schema loading pipeline (base: PR 2)

Merge checklist:

  • Version bumped
  • Changelog record added
  • 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

Adds 0025 ADR describing how authorization schema definitions and
their source are tracked. Part 1 of the schema loading pipeline stack.
@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 Sep 10, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @rodmgwgu!

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.

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

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: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants