Skip to content

Conversation

@CodeWithEmad
Copy link
Member

Corrected various typos in the codebase and enhanced documentation with syntax highlighting for better readability.
a rewrite of #156

@taimoor-ahmed-1 @Ali-Salman29

@openedx-webhooks
Copy link

openedx-webhooks commented Mar 7, 2025

Thanks for the pull request, @CodeWithEmad!

This repository is currently maintained by @openedx/wg-maintainers-forums.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 7, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Mar 7, 2025
@CodeWithEmad CodeWithEmad requested review from Ali-Salman29 and taimoor-ahmed-1 and removed request for Ali-Salman29 March 7, 2025 11:51
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Mar 11, 2025
@mphilbrick211 mphilbrick211 requested a review from a team May 27, 2025 19:56
@mphilbrick211
Copy link

Hi @openedx/wg-maintainers-forums! Would someone be able to review / merge this?

@openedx-webhooks openedx-webhooks added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label May 27, 2025
@mphilbrick211
Copy link

Hi @openedx/wg-maintainers-forums! Any chance we can get this looked at? It's been stalled a bit.

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.

This PR needs a rebase.

README.rst Outdated
The only prerequisite for installation is a working Open edX platform with `Tutor <https://docs.tutor.edly.io/>`__, on the Sumac release (v19+) or the `main branch <https://docs.tutor.edly.io/tutorials/main.html>`__. Enable the forum by running::
The only prerequisite for installation is a working Open edX platform with `Tutor <https://docs.tutor.edly.io/>`__, on the Sumac release (v19+) or the `main branch <https://docs.tutor.edly.io/tutorials/main.html>`__. Enable the forum by running:

.. code-block:: bash
Copy link
Contributor

Choose a reason for hiding this comment

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

i disagree with this change, because rendering this as a bash codeblock erroneously highlights bash keywords. I think this README is better with generic codeblocks for the shell commands. The python and yaml blocks are a value-add.


@classmethod
def threads_presentor(
def threads_presenter(
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this going to have an effect outside of this app? I don't think correcting typos that exist as part of method or class names is worth potential downstream breakages.

@sarina sarina moved this from Ready for Review to Waiting on Author in Contributions Sep 16, 2025
@mphilbrick211
Copy link

Hi @CodeWithEmad - just checking in to see if you are still working on this?

@mphilbrick211 mphilbrick211 added the inactive PR author has been unresponsive for several months label Nov 6, 2025
@CodeWithEmad
Copy link
Member Author

It's ready for review
@sarina @mphilbrick211

- typos fixed
- syntax highlighting added
@sarina
Copy link
Contributor

sarina commented Dec 10, 2025

Looks like tests are failing @CodeWithEmad

@mphilbrick211 mphilbrick211 removed the inactive PR author has been unresponsive for several months label Dec 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

4 participants