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

Reworked README for improved clarity #1002

Merged
merged 13 commits into from
Dec 19, 2024
Merged

Conversation

that-ar-guy
Copy link
Contributor

fixes: #1001

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

openedx-webhooks commented Dec 14, 2024

Thanks for the pull request, @that-ar-guy!

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

Copy link
Contributor

@Ian2012 Ian2012 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 your contribution. I've requested a couple of changes

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
@bmtcril
Copy link
Contributor

bmtcril commented Dec 16, 2024

And we will need that signed CLA as noted in the webhook comment in order to be able to accept the PR. Let me know if you need any help with that process!

@that-ar-guy
Copy link
Contributor Author

And we will need that signed CLA as noted in the webhook comment in order to be able to accept the PR. Let me know if you need any help with that process!

Done

@bmtcril bmtcril dismissed Ian2012’s stale review December 18, 2024 13:46

I'm not sure if/when he'll be able to re-review.

Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

Looks good, just a few more suggestions!

README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@itsjeyd itsjeyd added needs test run Author's first PR to this repository, awaiting test authorization from Axim waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Dec 19, 2024
Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

Awesome work, thanks for the updates and quick turnaround on feedback!

@bmtcril bmtcril merged commit 067880e into openedx:main Dec 19, 2024
1 check passed
@that-ar-guy
Copy link
Contributor Author

Thank you to all the maintainers for reviewing and merging my changes! As someone new to open-source, I’m eager to learn and improve. If you have any feedback or advice on my contribution or how I can better approach such projects, I’d truly appreciate it.
Looking forward to contributing more!

@bmtcril
Copy link
Contributor

bmtcril commented Dec 19, 2024

@that-ar-guy I think you did all the right things! We're a big project with a lot of different areas, so the best advice I have is to try to find an area of interest and see which things are tagged good first issue there to get familiar with things. If you're not on the Slack or forums those are good places to ask questions and find things that people would like help with. There are some links toward the bottom of this page: https://openedx.org/community/connect/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs test run Author's first PR to this repository, awaiting test authorization from Axim open-source-contribution PR author is not from Axim or 2U waiting for eng review PR is ready for review. Review and merge it, or suggest changes.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Rework README
6 participants