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

refactor: Change the formatting of the community PR message to make it tighter #339

Merged

Conversation

xitij2000
Copy link
Contributor

@xitij2000 xitij2000 commented Jan 23, 2025

The current message is too spaced out, this change fixes the spacing issues and moves the hr to the correct place.

The h3 and h4 have been removed since they add too much spacing around in the collapsable and make the message seem too spaced out. Being inside a collapsable section already highlights them quite a bit so I'm hoping this is okay.

Screenshot after update:
Screen Shot 2025-01-23 at 11 12 55

@openedx-webhooks
Copy link

openedx-webhooks commented Jan 23, 2025

Thanks for the pull request, @xitij2000!

This repository is currently maintained by @feanil.

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.


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 Jan 23, 2025
@xitij2000 xitij2000 marked this pull request as ready for review January 23, 2025 05:43
@xitij2000 xitij2000 requested review from itsjeyd and feanil January 23, 2025 05:44
Copy link

codecov bot commented Jan 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.72%. Comparing base (a68311a) to head (9824556).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #339   +/-   ##
=======================================
  Coverage   89.72%   89.72%           
=======================================
  Files          38       38           
  Lines        3026     3026           
  Branches      229      229           
=======================================
  Hits         2715     2715           
  Misses        279      279           
  Partials       32       32           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@itsjeyd itsjeyd left a comment

Choose a reason for hiding this comment

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

Thanks @xitij2000, this looks great 👍

@itsjeyd itsjeyd added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Jan 24, 2025
@itsjeyd
Copy link

itsjeyd commented Jan 30, 2025

Hey @feanil, this is just a small follow-up for openedx/wg-coordination#147, would you mind giving it a quick look?

@xitij2000 xitij2000 force-pushed the kshitij/fix-spacing-community-pr-comment branch from 87aaef2 to 0260442 Compare January 30, 2025 12:30
@feanil
Copy link
Contributor

feanil commented Jan 31, 2025

@xitij2000 this needs a rebase but then I can merge and deploy it.

@xitij2000 xitij2000 force-pushed the kshitij/fix-spacing-community-pr-comment branch 2 times, most recently from 5d95078 to 5291159 Compare February 3, 2025 12:44
@xitij2000
Copy link
Contributor Author

Not sure why the test are failing here. Doesn't seem to be related to the changes, but I'll have a closer look later.

@xitij2000
Copy link
Contributor Author

I've hopefully fixed the test issues.

@itsjeyd
Copy link

itsjeyd commented Feb 6, 2025

@xitij2000 I came here again today as part of my weekly OSPR management pass and saw that the build was green but the branch had fallen out of date with the base branch again. So to speed things up I figured I'd merge in the latest changes from master myself, wait for the build to pass, and ping Feanil for review again. Unfortunately the merge seems to have (re-)introduced a test failure. Sorry about that! Could you please have a look when you get a minute?

@itsjeyd itsjeyd added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Feb 6, 2025
@xitij2000 xitij2000 force-pushed the kshitij/fix-spacing-community-pr-comment branch from 81124d5 to fb6e605 Compare February 6, 2025 09:30
@xitij2000
Copy link
Contributor Author

@itsjeyd No worries! I just needed to drop my commit with the temporary fix.

… spacing

The current message is too spaced out, this change fixes the spacing issues and
moves the hr to the correct place.
@xitij2000 xitij2000 force-pushed the kshitij/fix-spacing-community-pr-comment branch from fb6e605 to 9824556 Compare February 6, 2025 09:34
@itsjeyd
Copy link

itsjeyd commented Feb 6, 2025

@xitij2000 Ah OK 😅 That's great.

@feanil We got a green build here now, could you please merge this PR? That'll wrap up openedx/wg-coordination#147.

@itsjeyd itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Feb 6, 2025
@feanil feanil merged commit 458431a into openedx:master Feb 10, 2025
6 checks passed
@feanil
Copy link
Contributor

feanil commented Feb 10, 2025

The update is now deployed. Thanks @xitij2000

@xitij2000 xitij2000 deleted the kshitij/fix-spacing-community-pr-comment branch February 11, 2025 01:53
@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Feb 13, 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
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants