Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Which repositories belong in the openedx GitHub organization, versus other GitHub organizations? Eventually, we'll have an OEP describing that. In the mean time, see our interim guidance.

If you believe that:

...

Transferring repos into openedx

...

a repository from openedx should be moved out to another GitHub organization,

...

Submit a GitHub Request - Access/Config issue to our request portal, detailing what you think should be transferred in and why. The request should come from an established contributor to the Open edX project, ideally a principal+ engineer or engineering manager.

If you want to make a new repository in the openedx organization, then first create it in your personal/company organization, and then follow the transfer request process above.If you want to archivea repository from the openedx organization please check out OEP-14: Archiving GitHub Repositoriesit’s established that the repo should be transferred into openedx, then the on-call engineer will guide you through one of the following transfer methods (unless you request otherwise, we typically use Option 1a):

  • Option 1: Transfer. This moves the entire repository, including PRs and issues, into the openedx organization. GitHub will forward links from the original location to the new openedx location indefinitely, provided that a repo of the same name is not created at the original location. There are two ways we can instrument the transfer:

    1. You add the tCRIL on-call engineer to your repository as an outside collaborator with admin rights (you do not need to make the tCRIL engineer a member of your GitHub organization). Then, they will transfer the repository into the openedx organization.

    2. You and the tCRIL on-call engineer get on a screenshare. The on-call engineer will temporarily grant you admin access to the entire openedx organizion. This will allow you to transfer your repository into the openedx organization. The on-call engineer will then revoke your admin rights to the openedx organization.

  • Option 1: Fork. This makes a parallel copy of the repository in the openedx organization. The original copy will still exist, along with any issues and PRs. GitHub will not forward links from the original location to the new openedx location. tCRIL on-call can do this without needing to be granted any special permissions.

Transferring repos out of openedx

Submit a GitHub Request - Access/Config issue to our request portal, detailing what you think should be transferred out and why. From there, we will discuss what to do next.

Making a new repo in the openedx organization

Submit a GitHub Request - Access/Config issue to our request portal, detailing what you want the repository to be named and why you would like it to be crated. From there, we will discuss what to do next.

Archiving a repo in the openedx organization

Follow the process OEP-14: Archiving GitHub Repositories. Submit a GitHub Request - Access/Config issue to our request portal if you need help from someone with admin access to the openedx GitHub org.

🛠 Offboarding & access changes, and other requests

...