Skip to content

Fix docstring for completion events transformer#550

Merged
saraburns1 merged 1 commit into
openedx:masterfrom
Vishwajit-Herma:patch-1
May 4, 2026
Merged

Fix docstring for completion events transformer#550
saraburns1 merged 1 commit into
openedx:masterfrom
Vishwajit-Herma:patch-1

Conversation

@Vishwajit-Herma
Copy link
Copy Markdown
Contributor

Fix the naming error docstring. ('forum' to 'completion')

Description: Describe in a couple of sentences what this PR adds

JIRA: Link to JIRA ticket

Dependencies: dependencies on other outstanding PRs, issues, etc.

Merge deadline: List merge deadline (if any)

Installation instructions: List any non-trivial installation
instructions.

Testing instructions:

  1. Open page A
  2. Do thing B
  3. Expect C to happen
  4. If D happened instead - check failed.

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.

Author concerns: List any concerns about this PR - inelegant
solutions, hacks, quick-and-dirty implementations, concerns about
migrations, etc.

Fix the naming error docstring. ('forum' to 'completion')
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 4, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @Vishwajit-Herma!

This repository is currently maintained by @ziafazal.

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.

@saraburns1 saraburns1 merged commit ff2e1bd into openedx:master May 4, 2026
7 of 8 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions May 4, 2026
@Vishwajit-Herma Vishwajit-Herma deleted the patch-1 branch May 5, 2026 04:20
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

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants