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 #287

Merged
merged 7 commits into from
Mar 29, 2024

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Mar 29, 2024

Description:

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.
  • Fixes quality issues in CHANGELOG
  • fixes bugs to allow use of manage.py shell
  • minor updates to PR template

JIRA:

Private-ref: FAL-3684

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

Merge checklist:

  • All reviewers approved
  • CI build is green -- enough. Can't codecov this change without code changes.
  • Version bumped - N/A
  • Changelog record added - N/A
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag - N/A
  • Check new version is pushed to PyPi after tag-triggered build is finished. - N/A
  • Delete working branch (if not needed anymore)

with new maintainer information.
* fix typo in default settings module
* add default urls.py
See OEP-55 / 0003 README specification
to match cookiecutter defaults
We tag reviewers in github now.
* use Open edX instead of edX
* reverts LICENSE move
@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.

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.

A couple suggestions, merge when you're ready.

README.rst Outdated Show resolved Hide resolved

Getting Help
------------
.. _the documentation: https://docs.openedx.org/projects/completion
Copy link
Contributor

Choose a reason for hiding this comment

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

This link doesn't work for me

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

(same issue for edx-submissions, btw)

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, that page is archived and I don't know the current procedure. @feanil can you help out here?

README.rst Outdated Show resolved Hide resolved
@pomegranited pomegranited merged commit 9811959 into master Mar 29, 2024
7 of 9 checks passed
@pomegranited pomegranited deleted the jill/maint-cleanup branch March 29, 2024 02:06
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