Skip to content

Conversation

@dwong2708
Copy link
Contributor

@dwong2708 dwong2708 commented Jul 24, 2025

Summary

This PR renames the function register_content_models to register_publishable_models to improve clarity and better reflect its purpose.

Context

The original name register_content_models was ambiguous and didn’t clearly convey the function’s responsibility. Since the function specifically registers models intended to be published (e.g., in learning sequences or metadata definitions), the new name register_publishable_models is more accurate and aligned with its role.

What’s Changed

  • ✅ Renamed register_content_models to register_publishable_models in both implementation and usage.
  • 🔄 Updated all relevant references and imports.

Testing Instructions

  • Run the test suite to ensure all references to the renamed function are working correctly.
  • Verify that no functional behavior has changed—this is a non-functional rename for clarity only.

Review Notes

  • No logic has been altered—only a renaming refactor for clarity and maintainability.
  • Please confirm naming consistency and suggest alternatives if the new name could be improved further.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 24, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jul 24, 2025

Thanks for the pull request, @dwong2708!

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.


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 Jul 24, 2025
@dwong2708 dwong2708 marked this pull request as ready for review July 24, 2025 16:49
@dwong2708 dwong2708 requested a review from ormsbee July 24, 2025 16:50
@ormsbee ormsbee merged commit 5233181 into openedx:main Jul 24, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Jul 24, 2025
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

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants