docs: [FC-0074] add follow-up questions to decide which type of hook to use #618
Conversation
|
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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf 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 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
mariajgrimaldi
force-pushed
the
MJG/further-questions-adoption
branch
from
48ebcf5 to
3c3b1ed
Compare
mariajgrimaldi
changed the title
| - Consider if your use case involves communication, synchronization, or integration between services or components. | ||
| - Next, review existing :doc:`openedx-filters:reference/real-life-use-cases` to find similar implementations. | ||
|
|
||
| We encourage you to review the list of use cases for events and filters to draw inspiration from real-life scenarios and see if your use case aligns with any of them. Also, maybe your feature can be implementing using the framework but there's not an available event or filter for it yet. In that case, consider proposing a new event or filter to the community! |
There was a problem hiding this comment.
If we go with closing this PR, I think we should include at least these last few lines :)
| **If the answer is no, should it be an event?** | ||
|
|
||
| - Consider if your use case involves communication, synchronization, or integration between services or components. | ||
| - Next, review existing :doc:`openedx-filters:reference/real-life-use-cases` to find similar implementations. |
There was a problem hiding this comment.
Should this refer to the events doc?
| **If the answer yes, should it be a filter? Does the application behavior benefit from being altered?** | ||
|
|
||
| - If so, a filter may suit your needs. | ||
| - If not, maybe because your use case should be the default offering of the platform, contribute changes if they benefit the community, but check with the `Product Working Group`_ first. |
There was a problem hiding this comment.
I might say
| - If not, maybe because your use case should be the default offering of the platform, contribute changes if they benefit the community, but check with the `Product Working Group`_ first. | |
| - If not, maybe because your use case should be the default offering of the platform, contribute changes if they benefit the community, consider submitting a `Product Proposal`_ to begin discussing changes to the default offering. |
and then link to https://openedx.atlassian.net/wiki/spaces/COMM/pages/3875962884/How+to+submit+an+open+source+contribution+for+Product+Review
There was a problem hiding this comment.
Thank you! b253115
Description
This PR adds a few follow-up questions to decide whether to use an event or a filter. This is only a proposal to clarify even more which hook to use, so if you think this is redundant, then I'm okay with closing this PR.