Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [FC-0074] add real life use cases based on community adoption #228

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Nov 15, 2024

Description

This PR adds a list of community use cases based on the results of GraphQL queries and GH searches. You can review the result here: https://docsopenedxorg--228.org.readthedocs.build/projects/openedx-filters/en/228/reference/real-life-use-cases.html

@mariajgrimaldi mariajgrimaldi requested a review from a team as a code owner November 15, 2024 14:10
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 15, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @mariajgrimaldi!

What's next?

Please work through the following steps to get your changes 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.

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

Who will review my changes?

This repository is currently maintained by @openedx/hooks-extension-framework. 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:

  • 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.

Copy link
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.

Would it make sense to add a sentence at the bottom inviting readers to submit a PR to this repo to add in their own filter examples if they wish?

@mariajgrimaldi
Copy link
Member Author

@sarina: I love the idea! I'm on it :)

* `Render Alternative Course About`_.
* `Hide Course About from Users Without Memberships`_.

.. note:: If you have implemented a solution using Open edX Filters and would like to share it with the community, please submit a pull request to add it to this list!
Copy link
Contributor

Choose a reason for hiding this comment

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

Love it!

@mariajgrimaldi mariajgrimaldi changed the title docs: add real life use cases based on community adoption docs: [FC-0074] add real life use cases based on community adoption Nov 18, 2024
@mariajgrimaldi mariajgrimaldi added the FC Relates to an Axim Funded Contribution project label Nov 18, 2024
@mariajgrimaldi mariajgrimaldi merged commit ab4d0be into main Nov 21, 2024
8 checks passed
@mariajgrimaldi mariajgrimaldi deleted the MJG/real-life-use-cases branch November 21, 2024 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants