Skip to content

Instantly share code, notes, and snippets.

@itsjeyd
Created April 18, 2024 12:32
Show Gist options
  • Save itsjeyd/a311f90c28dae77d2f5fddd72ebd47b7 to your computer and use it in GitHub Desktop.
Save itsjeyd/a311f90c28dae77d2f5fddd72ebd47b7 to your computer and use it in GitHub Desktop.

Thanks for the pull request, @{{ user }}!

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

πŸ”˜ Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation. Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign. See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed. After this time, you can re-run the CLA check by adding a comment below that you have signed it. If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

πŸ”˜ Wait for tests to be enabled

It looks like you are contributing to this repository for the first time. This means that automated tests won't run automatically, and that you'll need to wait for a test run to be authorized.

If you're experiencing a delay of two weeks or more at this step, tag the community contributions project managers in a comment and ask for help.

πŸ”˜ 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.

πŸ”˜ Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

πŸ”˜ Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @{{ maintainers }}. Tag them in a comment and let them know that your changes are ready for review.

This repository is currently unmaintained. To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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.

@itsjeyd
Copy link
Author

itsjeyd commented Apr 18, 2024

Check the raw version of the text to see which parts the bot would include conditionally / unconditionally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment