chore: README updated #1396

CodeWithEmad · 2024-05-25T12:42:25Z

This will fix some issues in the readme:

code blocks added.
heading issues fixed.
small typos fixed.

Also in the readme said:

lease tag @edx/engage-squad on any PRs or issues.

I wanted to tag @edx/engage-squad but looks like this account is deleted. should I update that too?

openedx-webhooks · 2024-05-25T12:42:29Z

Thanks for the pull request, @CodeWithEmad! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

codecov · 2024-05-25T12:47:43Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.83%. Comparing base (e3ecee1) to head (b01a129).
Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1396      +/-   ##
==========================================
+ Coverage   88.76%   88.83%   +0.07%     
==========================================
  Files         305      307       +2     
  Lines        5234     5268      +34     
  Branches     1327     1304      -23     
==========================================
+ Hits         4646     4680      +34     
  Misses        572      572              
  Partials       16       16

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

itsjeyd · 2024-05-31T07:50:16Z

@CodeWithEmad Thank you for this contribution! We've got a green build so I'm marking it as ready for review now, but let me know if you had plans to work on it some more.

itsjeyd · 2024-05-31T07:52:12Z

Hey @openedx/2u-aurora team, this PR is ready for review.

CodeWithEmad · 2024-05-31T08:26:40Z

If @openedx/2u-aurora team maintains this repo, let me update the @edx/engage-squad mentioned in the readme.

itsjeyd · 2024-06-06T07:50:57Z

@CodeWithEmad Sounds good!

BTW, if a repo is maintained, it'll have the maintainer(s) listed as owner in its catalog-info.yaml file (example). So if you're ever unsure about the maintenance status of a repo you can just check that file.

CodeWithEmad · 2024-06-06T08:29:40Z

Got it.

itsjeyd · 2024-06-19T11:40:47Z

Hi @openedx/2u-aurora team, could you have a look at this PR please?

itsjeyd · 2024-06-26T11:59:45Z

Reached out to core contributors via Slack.

sarina

Looks good, please address the point about catalog-info and we can get this merged.

sarina · 2024-06-26T12:34:30Z

README.rst


 This is the Learning MFE (micro-frontend application), which renders all
 learner-facing course pages (like the course outline, the progress page,
 actual course content, etc).

-Please tag **@edx/engage-squad** on any PRs or issues.  Thanks.
+Please tag **@openedx/2u-aurora** on any PRs or issues. Thanks.


Let's remove this line, or point at the https://github.com/openedx/frontend-app-learning/blob/master/catalog-info.yaml file. All repos are migrating to using catalog-info so let's not make it error prone by duplicating the info.

I'll remove it but I had PRs in the past stuck in review for months before I mentioned someone. Also, this pattern (mentioning the owner for review) is repeated in other repos like Profile MFE. What's the best solution here?

@CodeWithEmad It's completely fine to ping repo maintainers for review if they don't respond to a PR within a week or two.

I think @sarina's comment was more about not putting information about who owns a repo into two places. (Because it's easy to forget updating it in both places when it changes, especially when there's a widely accepted default for where this information should go.)

If you wanted to update the README of this repo to mention that PR authors should ping repo maintainers for review, you could still do that. Just keep it neutral -- i.e., instead of explicitly mentioning the current maintainer(s) in the README, tell the reader to check https://github.com/openedx/frontend-app-learning/blob/master/catalog-info.yaml to find out who to ping 🙂

Exactly right, it's about duplicating information. I like @itsjeyd 's suggestion of pointing people to the catalog-info.yaml file.

sarina · 2024-06-26T12:34:56Z

README.rst

@@ -1,25 +1,22 @@
-#####################


just FYI the overlines are not wrong, it's OK to leave them in. But OK that you've removed them.

Yes, I am aware of that. I am just trying to ensure all the documents have a consistent appearance.

sarina · 2024-06-26T12:38:47Z

README.rst


  Example: https://support.edx.org/hc/en-us/articles/360000038428-Entering-math-expressions-in-assignments-or-the-calculator

 SUPPORT_URL_ID_VERIFICATION
  A link that explains how to verify your ID. Shown in contexts where you need
  to verify yourself to earn a certificate. The example link below is probably too
-  edx.org-specific to use for your own site.
+  edx.org-specific to use for your site.


I like this sentence better without this change, but will not block merging on this feedback.

I have no objections to it. I'll revert the change.

- code blocks added. - heading issues fixed. - small typos fixed.

openedx-webhooks · 2024-06-28T13:09:42Z

@CodeWithEmad 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 25, 2024

itsjeyd added waiting for eng review PR is ready for review. Review and merge it, or suggest changes. needs reviewer assigned PR needs to be (re-)assigned a new reviewer labels May 31, 2024

CodeWithEmad force-pushed the chore/readme branch from 5f99de2 to 03eefcb Compare May 31, 2024 08:41

itsjeyd requested a review from a team June 19, 2024 11:39

sarina requested changes Jun 26, 2024

View reviewed changes

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. needs reviewer assigned PR needs to be (re-)assigned a new reviewer labels Jun 27, 2024

chore: README updated

b01a129

- code blocks added. - heading issues fixed. - small typos fixed.

CodeWithEmad force-pushed the chore/readme branch from 03eefcb to b01a129 Compare June 28, 2024 11:22

sarina approved these changes Jun 28, 2024

View reviewed changes

sarina merged commit c7a81fe into openedx:master Jun 28, 2024
7 checks passed

CodeWithEmad deleted the chore/readme branch June 28, 2024 13:21

itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Jul 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: README updated #1396

chore: README updated #1396

CodeWithEmad commented May 25, 2024 •

edited

Loading

openedx-webhooks commented May 25, 2024

codecov bot commented May 25, 2024 •

edited

Loading

itsjeyd commented May 31, 2024

itsjeyd commented May 31, 2024

CodeWithEmad commented May 31, 2024 •

edited

Loading

itsjeyd commented Jun 6, 2024

CodeWithEmad commented Jun 6, 2024

itsjeyd commented Jun 19, 2024

itsjeyd commented Jun 26, 2024

sarina left a comment

sarina Jun 26, 2024

CodeWithEmad Jun 28, 2024 •

edited

Loading

itsjeyd Jul 12, 2024

sarina Jul 12, 2024

sarina Jun 26, 2024

CodeWithEmad Jun 28, 2024

sarina Jun 26, 2024

CodeWithEmad Jun 28, 2024

openedx-webhooks commented Jun 28, 2024

chore: README updated #1396

chore: README updated #1396

Conversation

CodeWithEmad commented May 25, 2024 • edited Loading

openedx-webhooks commented May 25, 2024

codecov bot commented May 25, 2024 • edited Loading

Codecov Report

itsjeyd commented May 31, 2024

itsjeyd commented May 31, 2024

CodeWithEmad commented May 31, 2024 • edited Loading

itsjeyd commented Jun 6, 2024

CodeWithEmad commented Jun 6, 2024

itsjeyd commented Jun 19, 2024

itsjeyd commented Jun 26, 2024

sarina left a comment

Choose a reason for hiding this comment

sarina Jun 26, 2024

Choose a reason for hiding this comment

CodeWithEmad Jun 28, 2024 • edited Loading

Choose a reason for hiding this comment

itsjeyd Jul 12, 2024

Choose a reason for hiding this comment

sarina Jul 12, 2024

Choose a reason for hiding this comment

sarina Jun 26, 2024

Choose a reason for hiding this comment

CodeWithEmad Jun 28, 2024

Choose a reason for hiding this comment

sarina Jun 26, 2024

Choose a reason for hiding this comment

CodeWithEmad Jun 28, 2024

Choose a reason for hiding this comment

openedx-webhooks commented Jun 28, 2024

CodeWithEmad commented May 25, 2024 •

edited

Loading

codecov bot commented May 25, 2024 •

edited

Loading

CodeWithEmad commented May 31, 2024 •

edited

Loading

CodeWithEmad Jun 28, 2024 •

edited

Loading