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

Adds catalog-info.yaml and updates README as per OEP-55 #233

Merged
merged 4 commits into from
Mar 29, 2024

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Mar 29, 2024

Following the steps in How to maintain a repo, this PR:

  • adds catalog-info.yaml to record maintainership in Backstage
  • updates README.rst to use current cookiecutter format.
  • moves LICENSE to LICENSE.txt to match cookiecutter defaults.

Testing instructions:

To test this change, please follow the updated README#getting-started-with-development

Author Notes & Concerns

This repo has docs, but they're not published to docs.openedx.org yet.

Could someone with access please add them? Procedure noted here: https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs

with new maintainer information.
See OEP-55 / 0003 README specification
to match cookiecutter defaults
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 29, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited! 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.

@pomegranited
Copy link
Contributor Author

Hi @feanil @sarina sorry to bug you directly, but I don't think there's anyone else on the CC/maintainer list for this repo.

Could one of you review this PR when you get a chance?

Copy link

codecov bot commented Mar 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.43%. Comparing base (0106916) to head (609553a).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #233   +/-   ##
=======================================
  Coverage   93.43%   93.43%           
=======================================
  Files          18       18           
  Lines        1995     1995           
  Branches      130      130           
=======================================
  Hits         1864     1864           
  Misses        118      118           
  Partials       13       13           
Flag Coverage Δ
unittests 93.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

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.

Looks good!

@pomegranited pomegranited merged commit a354b77 into master Mar 29, 2024
10 checks passed
@pomegranited pomegranited deleted the jill/maint-cleanup branch March 29, 2024 01:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants