Cumulative Maintainer Responsibilities

Over the course of the maintenance pilot we have been adding additional responsibilities bit-by-bit. This is the cumulative view of what those responsibilities are and how we are doing against our commitments. This version is a self-assessment so each maintainer should complete this for the repositories under maintenance.

Responsibilities

  1. Create a useful catalog-info.yaml file.

  2. Bring the README in line with our standards.

  3. Requirements bot is installed.

  4. GitHub Notifications are enabled
    Maintainers must update their GitHub notification settings so that they are getting PR messages and can be tagged

  5. GitHub Issues are enabled

  6. The maintainers are reachable in Discourse

    1. For individual maintainers: Maintainers should have accounts and should receive notifications if they are directly mentioned in regards to maintainer responsibilities.

    2. For team maintainers: This workflow is still evolving. Some examples:

      1. https://openedx.atlassian.net/wiki/spaces/COMM/pages/3739910145

      2. https://openedx.atlassian.net/wiki/spaces/COMM/pages/3695181836

  7. Incoming Pull Requests from community members should be triaged within a week.
    The goal is to reduce lead-time to finalize contributions from folks who do not have direct merge rights to a repository. Ideally finalize is to merge the change, but it can also be rejecting it. The contributor should know quickly and definitively whether the change was merged, rejected or requires changes. This SLA is currently measuring time to triage the PR. Triaging means acknowledging the contribution and giving the author clarity about what happens next: I’ll review this tomorrow, it is in our next sprint starting Monday, etc. And, crucially fulfilling the expectations you have set about what happens next.

    Incoming pull requests are visible here. Teams typically are on the hook for items that are in the “Ready for Review” state.

    Community Project Managers – @Michelle Philbrick and @Tim Krones – are continuously watching, curating, cajoling, unblocking these pull requests to keep their statuses accurate.

  8. Author updates should be responded to within a week.
    This requirement is really an extension of the above, but focused on making sure reviews get to done when authors are responsive. Ideally when authors are responsive, we are keeping reviews active and not pushing across sprint boundaries for every interaction.

  9. Security fixes should be applied weekly
    The edx-requirements bot will create pull requests in your repository to update any out of date requirements. The bot, however, doesn’t specifically flag which updates are security fixes. You may get this information by enabling Dependabot from your repositories settings. You can configure it to send alerts, but not create pull requests. Dependabot alerts will be visible from the “Security” tab in your repositories.

Current Scorecard

Repo

Phase Added

Maintainer

Maintainer Org

catalog-info.yaml

Readme up-to-date

Requirements bot

GitHub Notifications

GitHub Issues

Slack Username(s)

Discourse reach-ability

Process Doc for Regular Periodic Responsibilities

Repo

Phase Added

Maintainer

Maintainer Org

catalog-info.yaml

Readme up-to-date

Requirements bot

GitHub Notifications

GitHub Issues

Slack Username(s)

Discourse reach-ability

Process Doc for Regular Periodic Responsibilities

frontend-platform

Phase 2

fed-bom - @Muhammad Abdullah Waheed Khan

2U

Yes

Yes

Yes

Yes

Yes

@mawkhan

Abdullah_Waheed

 

frontend-app-profile

Phase 2

Aperture

2U

Yes

Yes

Yes

 

Yes

@Kelly Buchanan

https://openedx.atlassian.net/wiki/spaces/COMM/pages/3739910145

openedx-filters

Phase 2

Felipe/Maria

eduNEXT

Yes

Yes

Yes

Yes

Yes

@Felipe Montoya
@MariaGrimaldi

Felipe
Maria

 

paragon

Phase 2

2U - @Adam Stankiewicz

2U

Yes

Yes

Yes

 

Yes

@astankiewicz

Yes

 

xblock-drag-and-drop-v2

Phase 2

OpenCraft - @Piotr Surowiec

OpenCraft

Yes

Yes

Yes

Yes

Yes

@Piotr

Yes

 

django-config-models

Phase 2

arch-bom

2U

Yes

Yes

Yes (Dependabot)

 

Yes

 

 

Open edX Documentation

Phase 2

Feanil

Axim

Yes

Yes

Yes

 

Yes

@feanil

Yes

edx-django-utils

Phase 2

arch-bom

2U

Yes

Yes

Yes

 

Yes

 

 

frontend-app-library-authoring

Phase 2

TNL

2U

Yes

Yes-ish

Yes (Dependabot)

Yes (CODEOWNERS)

Enabled

@jristau

Yes
(Jeremy Ristau)

frontend-app-discussions

Phase 2

Infinity

2U

Yes

Yes

Yes

 

Yes

@Asad Azam

 

 

frontend-app-ora-grading

Phase 2

Aurora

2U

Yes

Yes

Yes

Yes

Yes

@bwarzeski@Leangseu Kim

 

 

frontend-app-learner-record

Phase 2

Aperture

2U

Yes

Yes

Yes

 

Yes

@Kelly Buchanan

 

frontend-app-authn

Phase 2

Vanguards (Arbisoft / 2U) - @Zainab Amir

2U

Yes

Yes

Yes

Yes

Yes

@zainab amir

Yes

 

blockstore

Phase 1

OpenCraft - @Braden MacDonald @Piotr Surowiec

OpenCraft

Yes

Yes

Yes

Yes

Yes

@Braden

Yes

 

DoneXBlock

Phase 1

@Edward Zarecor (Axim)

Axim

Yes

Yes

Yes

Yes

Yes

@e0d

Yes

edx-ace

Phase 1

Vanguards (Arbisoft / 2U) - @Zainab Amir

2U

Yes

Yes

Yes

Yes

Yes

@zainab amir

Yes

 

edx-rest-api-client

Phase 1

Arch-BOM (2U)

2U

Yes

Yes

Yes

Yes

Yes

@nedbat

Yes

openedx-events

Phase 1

eduNEXT - @Felipe Montoya @Maria Grimaldi

eduNEXT

Yes

Yes

Yes

Yes

Yes

@Felipe Montoya
@MariaGrimaldi

Felipe
Maria

 

xblock-lti-consumer

Phase 1

Cosmonauts (2U) - @Zach Hancock

2U

Yes

Yes

Yes

Yes

Yes

@zhancock

Yes

 

course-discovery

Phase 1

Phoenix (Arbisoft / 2U)

2U

Yes

Yes (daily)

Yes

Yes

Yes

 

 

 

frontend-app-publisher

Phase 1

Phoenix (Arbisoft / 2U)

2U

In Process

In Process

Yes

Yes

Yes

 

 

 

credentials

Phase 1

Aperture (2U) - @Kelly Buchanan

2U

Yes

Yes

Yes

Yes

Yes

@Kelly Buchanan

 

XBlock

Phase 2

(Axim)

Axim

Yes

Yes

Yes

No

Yes

@feanil

Yes

xblock-sdk

Phase 2

(Axim)

Axim

Yes

Yes

Yes

Yes

Yes

@feanil

Yes

xblock-utils

Phase 2

(Axim)

Axim

Yes

Yes

Yes

Yes

Yes

@feanil

Yes

frontend-template-application

Phase 2

(Axim)

Axim

Yes

Yes

Yes

Yes

Yes

@arbrandes

Yes

react-unit-test-utils

Phase 3

Aurora

2U

No

No

No

No

Yes

@bwarzeski@Leangseu Kim

 

 

frontend-app-communications

Phase 2

Axim

Axim

Yes

Yes

Yes

 

Yes

@arbrandes

Yes

openedx-tutor-plugins

Phase 2

Axim

Axim

Yes

Yes

N/A - mono-repo without requirements beyond Tutor

 

Yes

@e0d

Yes