Skip to content

chore: add initial plugin folder structure#30

Merged
sarina merged 10 commits intoopenedx:mainfrom
eduNEXT:bav/add-plugin-folder-structure
Sep 3, 2025
Merged

chore: add initial plugin folder structure#30
sarina merged 10 commits intoopenedx:mainfrom
eduNEXT:bav/add-plugin-folder-structure

Conversation

@BryanttV
Copy link
Copy Markdown
Contributor

@BryanttV BryanttV commented Aug 27, 2025

Description

This PR adds the initial plugin folder structure. The purpose is to include CI validations in PRs, but it could be used to test implementations.

Generated using edx-cookiecutters > django-app. Some additional changes were made:

  1. Replaced the current README.md with the README.rst
  2. Deactivated the codecov patch check (for now), because the checks were failing.
  3. Generated the .txt files for the initial base requirements by running make upgrade
  4. Included setuptools requirement in the quality checks to solve pylint check failures
  5. Included Python 3.11 in the supported versions

@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 Aug 27, 2025
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @BryanttV!

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Aug 27, 2025
@BryanttV BryanttV force-pushed the bav/add-plugin-folder-structure branch 7 times, most recently from 63dd423 to 0500d29 Compare August 27, 2025 23:25
@sarina
Copy link
Copy Markdown
Contributor

sarina commented Aug 29, 2025

Is this just the cookie-cutter generation or is there something specific you'd like reviewed? Could you provide a self-review with anything you'd like 👀 on ?

Comment thread README.rst Outdated
Purpose
*******

For now, a placeholder repo covering upcoming implementation of RBAC (role-based access control) for the Open edX platform.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we update this with a more appropriate description?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mariajgrimaldi, purpose updated: 17d3802. What do you think?

@BryanttV BryanttV force-pushed the bav/add-plugin-folder-structure branch from 54637ac to 176389a Compare September 2, 2025 14:32
@BryanttV
Copy link
Copy Markdown
Contributor Author

BryanttV commented Sep 2, 2025

Is this just the cookie-cutter generation or is there something specific you'd like reviewed? Could you provide a self-review with anything you'd like 👀 on ?

Hi @sarina!

I just generated the folder structure with the cookiecutter and then:

  1. I replaced the current README.md with the README.rst
  2. I deactivated the codecov patch check (for now), because the checks were failing.
  3. I generated the .txt files for the initial base requirements by running make upgrade
  4. I included setuptools requirement in the quality checks to solve pylint check failures
  5. I included Python 3.11 in the supported versions

Comment thread README.rst
This repository contains the architecture and design decisions for the new authorization system in Open edX. The project aims to provide a more flexible and powerful framework for managing user access, designed to modernize and replace the legacy permission system.

See the `Product Requirements document for Roles & Permissions`_.
See the `Product Requirements document for Roles & Permissions`_ for detailed specifications and requirements.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about:

Open edX AuthZ provides the architecture and foundations of the authorization framework. It implements the core machinery needed to support consistent authorization across the Open edX ecosystem.

We can also draw inspiration from: https://github.com/openedx/openedx-authz/pull/28/files

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion! What do you think about: ec2c951

Copy link
Copy Markdown
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove changes to LICENSE.txt, we already have a LICENSE file (https://github.com/openedx/openedx-authz/blob/main/LICENSE)

Comment thread README.rst Outdated
:target: https://github.com/openedx/openedx-authz/blob/main/LICENSE.txt
:alt: License

.. TODO: Choose one of the statuses below and remove the other status-badge lines.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you remove the other status badge lines per this comment?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed: 92dbfe3

Comment thread README.rst
@BryanttV
Copy link
Copy Markdown
Contributor Author

BryanttV commented Sep 2, 2025

Please remove changes to LICENSE.txt, we already have a LICENSE file (https://github.com/openedx/openedx-authz/blob/main/LICENSE)

Thanks! deleted: 7e7072e

Copy link
Copy Markdown
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Copy link
Copy Markdown
Contributor

@MaferMazu MaferMazu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me ✨

@sarina sarina merged commit 0a321bf into openedx:main Sep 3, 2025
13 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Sep 3, 2025
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

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants