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.

Sign up for GitHub

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

Jump to bottom

chore: cleanup #646

Merged
merged 5 commits into from
Nov 14, 2024
Merged

chore: cleanup #646

merged 5 commits into from
Nov 14, 2024

Conversation

CodeWithEmad
Copy link
Member

This PR will introduce the following:

  • Remove trailing whitespaces
  • fix typos
  • add codeblock for better readability
  • fix heading styles

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 9, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @CodeWithEmad!

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 @sarina. 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.

@sarina sarina self-requested a review November 12, 2024 13:38
@sarina
Copy link
Contributor

sarina commented Nov 12, 2024

@CodeWithEmad thank you! I will review later this week.

sarina
sarina requested changes Nov 13, 2024
View reviewed changes
oeps/best-practices/oep-0066/Open_edX_Auth_Overview_Table.rst Outdated
@@ -1,6 +1,6 @@
Open edX Auth Overview Table
Copy link
Contributor

Choose a reason for hiding this comment

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

Please don't change/rename this file

Copy link
Member Author

Choose a reason for hiding this comment

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

You got it!

oeps/processes/oep-0055-proc-project-maintainers.rst Outdated
@@ -144,7 +144,7 @@ Historical Context
Historically, the Open edX project has not had a well-defined role
of maintainer. At times, community members stepped into this role
informally. The role was also part of a broader "owner" role at edX.
Owners were also responsible for the health of the component they
Owners were also responsible for the health of the components they
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Owners were also responsible for the health of the components they
Owners were also responsible for the health of the component(s) they

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure

oeps/processes/oep-0055-proc-project-maintainers.rst Outdated
do we ensure critical parts of the software supply chain, like
OpenSSL are maintained, etc. I have included some relevant
OpenSSL is maintained, etc. I have included some relevant
Copy link
Contributor

Choose a reason for hiding this comment

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

Rervert this change ("are" is referring to the plural "critical parts")

Copy link
Member Author

Choose a reason for hiding this comment

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

You're absolutely right!

sarina
sarina approved these changes Nov 14, 2024
View reviewed changes
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.

Thanks for this cleanup!

@sarina sarina merged commit 2068683 into openedx:master Nov 14, 2024
5 checks passed
@CodeWithEmad CodeWithEmad deleted the chore/cleanup branch November 14, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarina sarina sarina approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@CodeWithEmad @openedx-webhooks @sarina