Table of Contents

Who are we?

We are the engineering team of the Axim Collaborative (previously the Center for Reimagining Learning (, aka tCRIL, pronounced “tea-krill”). tCRIL Axim is the temporary name for a lasting non-profit which stewards the codebase and community of the Open edX Project.

...

The Team

Our Work

Contact Us

...

Axim Request Process

...

We take requests viathe New Issue portal on the openedx/tcrilAxim-engineering repository. tCRIL’s Axim’s rotating “on-call” engineer will triage your issue within one business day during their own working hours. They will try to give you a time estimate for completion. They may do the work themselves or delegate it to someone else. Note that tCRIL Axim does not generally provide support on weekends, holidays, the early morning, or the evening (~US-Eastern timezone).

Please fill out all request fields, including a helpful title. Make sure the title remains prefixed with [GH Request] so that our automation picks it up and routes it to the on-call engineer. So your ticket’s title would look something like, [GH Request] Onboard New User Bob Jones

Common Request Types

🎓 Onboarding edX/2U

...

Employees

So, you just started at edX/2U OCM? Congrats! 🎉 Either 2U IT or your manager should file a GitHub Request - Onboarding issue on your behalf. (Please don’t file file the request yourself--we need someone who is already in the openedx organization to vouch that you are indeed a new 2U OCM employee).

2U IT and managers: For new hires, file a GitHub Request - Onboarding issue with us. We often do not get to requests the day they are filed, so please file the request as far in advance of the employee’s start date as possible. Please provide a helpful title, but make sure it remains prefixed with [GH Request] so that our automation picks it up. Thanks!tCRIL On-Call:Ensure that the request is coming from a known 2U OCM manager or IT staff member. If so, invite the new hire to the openedx organization. Until further notice, as part of the invitation, add all new hires to the @openedx/push-pull-all group as well as any other sensible groups as requested. Close the issue once the invitation is sent.

🌐 Onboarding Core Contributors

So, you just became a core contributor? Congrats! 🎉 Your sponsor should file You should follow one of the following runbooks, depending on the role you have:

• Core Contributor Onboarding (Non-Coding roles)

• Core Contributor Onboarding (Coding roles)

🏗 Adding or removing repositories from the openedx GitHub organization

Transferring repos into openedx

Submit a GitHub Request - Generic issue on your behalf, with a link to the approving Discourse thread, your GH username, and the repos approved access for. If your sponsor is not responding to pings, you may file it yourself. Please first read the “For Those Joining” section here: https://openedx.atlassian.net/wiki/spaces/COMM/pages/2810249408/Core+Contributor+Committer+Runbook#For-Those-Joining-the-Core-Contributor-Program-as-a-Committer . A Core Contributor Program Administrator will be reaching out to send you the appropriate documents and ensure correct access.tCRIL On-Call:Right now, we follow this document: https://openedx.atlassian.net/wiki/spaces/COMM/pages/2810249408/Core+Contributor+Committer+Runbook#edX%3A-Adding-Someone-As-A-Committer and I expect these instructions to be in flux over the coming months, so I’m leaving that document separate. That list can be copied into a GH ticket & it’ll render as a checklist. Please put that checklist in the ticket description and mark off what’s been done. For the DocuSign, please ask one of the Program Administrators (cc-program-admins@tcril.org) to generate the envelopes for you and confirm their receipt before moving on to the latter sections.

🏗 Adding or removing repositories from the openedx GitHub organization

If you believe that:

• a repository from another GitHub organization should be moved into openedx, or

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

then submit a GitHub Request - Generic issue on the board linked aboveAccess/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 it’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 Axim on-call engineer to your repository as an outside collaborator with admin rights (you do not need to make the Axim engineer a member of your GitHub organization). Then, they will transfer the repository into the openedx organization.

  2. You and the Axim 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. Axim 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 in out and why. (Not sure? We are working on an OEP to formalize which repositories should be in the openedx organization and what the implications of being in said organization are. In the meantime, though, tCRIL is just using our best judgement. If you’re not sure, open a request anyway! Thanks for your patience here.)

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 respository from the openedx organization please check out 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 created, and what team should have access. From there, we will discuss what to do next.

Archiving a repo in the openedx organization

Follow the process OEP-14: Archiving GitHub Repositories. (tCRIL On-Call:Bring transfer requests to the team for discussion.)

...

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

Do you need us to:

• invite a user to Confluence?

• add or remove GitHub permissions from a user?

• change the configuration of a GitHub application?

• add a new github application?

• remove someone from the openedx GitHub organization?

• help you out with anything else?

File an issue using the tCRIL Axim Engineering board above, selecting the most appropriate template. Please provide reasoning for your change and as much supplemental detail as possible.

tCRIL On-Call:Use your best judgement. Ask in Slack or at standup if you’re unsure. Record any action you take and your reasoning in the issue comments before closing itIn the case of adding or removing non-Confluence permissions, please have your manager ask on your behalf.

Pages

...