openedx / openedx-learning

GNU Affero General Public License v3.0
5 stars 11 forks source link

docs: ADRs for modeling containers capability #251

Open mariajgrimaldi opened 3 weeks ago

mariajgrimaldi commented 3 weeks ago

Description

ADRs with high-level decisions regarding the modeling of containers as a generalized capability of holding content, selectors as a strategy for selecting content that builds on the container idea, and units as a concrete implementation of containers that can contain static and dynamic content through selectors.

These decisions resulted from discussions in #38 and #219, which were consolidated into issue #240.

In order to validate the proposal, we created a POC implementation #254 of what has been discussed so far. These ADRs and the POC are still a work in progress, but early reviews are welcome to validate the proposal.

openedx-webhooks commented 3 weeks ago

Thanks for the pull request, @mariajgrimaldi!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: Get product approval

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

:radio_button: 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:

:radio_button: 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.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @axim-engineering. Tag them in a comment and let them know that your changes are ready for review.

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:

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

mariajgrimaldi commented 1 week ago

Thank you, @bradenmacdonald, for your comments! I'll go through your review now :)

mariajgrimaldi commented 2 hours ago

I'm opening this PR for review as we continue to discuss the proposal, although it doesn't mean we've reached a consensus yet. Thank you!