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] use-events-to-call-webhook style review #466

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Apgomeznext
Copy link
Contributor

@Apgomeznext Apgomeznext commented Feb 13, 2025

Description

This PR modified the title codes according to the Open edX documentation style guide and a few style changes.

This PR also contains some changes from @mariajgrimaldi

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions. Also, link to any relevant documentation useful for reviewers.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Please provide detailed step-by-step instructions for testing this change, including any necessary setup, e.g., additional requirements, plugins, configuration variables, etc, and environment details to ensure the reviewer can test the change.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Any other PRs or issues that should be linked here? Any related PRs?
  • Any special concerns or limitations? For example: deprecations, security, or anything you think should be noted.

Checklists

Check off if complete or not applicable:

Merge Checklist:

  • All reviewers approved
  • Reviewer tested the code following the testing instructions
  • CI build is green
  • Version bumped
  • Changelog record added with short description of the change and current date
  • Documentation updated (not only docstrings)
  • Integration with other services reviewed
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

  • Create a tag
  • Create a release on GitHub
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)
  • Upgrade the package in the Open edX platform requirements (if applicable)

@Apgomeznext Apgomeznext requested a review from a team as a code owner February 13, 2025 17:51
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 13, 2025

Thanks for the pull request, @Apgomeznext!

This repository is currently maintained by @openedx/hooks-extension-framework.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 13, 2025
@Apgomeznext Apgomeznext requested review from sarina and mariajgrimaldi and removed request for sarina February 13, 2025 17:59
@Apgomeznext Apgomeznext marked this pull request as draft February 13, 2025 18:11
Apgomeznext and others added 3 commits February 13, 2025 13:42
- Link to openedx-events-2-zapier docs
- Reference other webhooks implementations besides zapier
- Update code according to latest changes in sample repo
- Add note about the repo not being tested in prod environments
@Apgomeznext Apgomeznext marked this pull request as ready for review February 13, 2025 21:26
@Apgomeznext Apgomeznext requested a review from sarina February 13, 2025 21:26
@mariajgrimaldi mariajgrimaldi removed their request for review February 14, 2025 08:15
@mariajgrimaldi
Copy link
Member

I removed my review request since this also includes my changes.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 14, 2025
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.

I didn't deeply review the code so another approving review from the hooks team would be good.

@sarina
Copy link
Contributor

sarina commented Feb 15, 2025

Does this include changes from #442 ?

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: Ready for Review
Development

Successfully merging this pull request may close these issues.

5 participants