Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 42 Next »

Comms

The Slack channel: #maintainers-pilot.

Scrum of Scrums

An initial gathering of maintainers will be planned for sometime in August 2022. This should include all the maintainers named in the pilot but will also be open to any other explicitly named maintainers.

Pilot repos

Repository

Maintainer

Catalog-info.yaml

Readme updated

Requirements bot

GitHub Notifications

GitHub Issues

Discourse reach-ability

1

blockstore

OpenCraft - Braden MacDonald Piotr Surowiec

Yes

Yes

Yes

Yes

Yes

Yes

2

DoneXBlock

Edward Zarecor (tCRIL)

Yes

Yes

Yes

Yes

Yes

Yes

3

edx-ace

Vanguards (Arbisoft / 2U) - Zainab Amir (Deactivated)

Yes

Yes

Yes

Yes

Yes

Yes

4

edx-rest-api-client

Arch-BOM (2U) - Ned Batchelder (Deactivated)

Yes

Yes

Yes

Yes

Yes

Yes

5

openedx-events

eduNEXT - Felipe Montoya Maria Grimaldi

Yes

Yes

Yes

Yes

Yes

Yes

6

RateXBlock

Edward Zarecor (tCRIL)

To be deprecated

Minimal

N/A

N/A`

N/A

N/A

7

xblock-lti-consumer

Cosmonauts (2U) - Zach Hancock

Yes

Yes

Needs schedule update

Yes

Yes

Yes

8

course-discovery

Phoenix (Arbisoft / 2U) - Azan Bin Zahid (Deactivated)

Yes

Yes

Yes (daily)

Yes

Yes

Yes

9

frontend-app-publisher

Phoenix (Arbisoft / 2U) -Azan Bin Zahid (Deactivated)

In Process

In Process

Yes

Yes

Yes

Yes

10

credentials

Aperture (2U) - Kelly Buchanan

Yes

No

Yes

Yes

Yes

Kelly Buchanan only. Need to discuss whole team reachability in phase 2 pilot.

Pilot Details

Quality Standards

A full set of quality standards are still in development, but as we add them, we are adding ADRs to OEP-55.

Pilot Requirements

The Pilot may have multiple phases. The first phase of the Pilot has been declared and its goals and timeline are below. Further phases may be added as we iterate with the pilot maintainers towards the pilot outcome.

Pilot Phase 1

Expected Outcomes

  • A valid and accurate catalog-info.yaml file exists in each repo in the pilot that follows the guidelines provided in OEP-55:ADR-1

  • Consistent READMEs

  • Requirements bot is running on at-least a weekly cadence for each repo in the pilot. Maintainers should get tagged for review and review and merge PRs in a timely manner (within a week of creation).

  • Maintainers have updated their GitHub notification settings so that they are getting PR messages / are taggable

  • GitHub Issues are enabled in all maintained repos

  • Maintainers are monitoring agreed upon communication channels

    • GitHub Issues specific to the repos they maintain

    • Discourse - All maintainers should have accounts and should receive notifications if they are directly mentioned.

Target Date

Pilot maintainers should complete all phase 1 work by September 16th.

Pilot Phase 2

Pilot Phase 2

Overall Pilot Expected Outcomes

We’re currently taking a multi-phase approach, but these are some overall outcomes from the full process:

  • The process for finding new maintainers is clear and documented.

  • A documented standard exists for basic maintainership artifacts

  • Communication gaps and missing rituals are identified and implemented

  • We are ready to add more repos to the official list of maintained repositories

Bootstrapping Maintainership, per OEP-55

This is the approved text from OEP-55 describing our intentions for the bootstrapping process:

In order to ensure an orderly roll-out of the formal maintainer role, existing 2U staff in the owner role will transition into the role of maintainer for the components that they own.

Community members who are acting in informal maintainer roles will also be asked to become named maintainers.

A list of all components and their maintainers will be created and published, including a list of the components without a maintainer.

An asynchronous channel will be available for all maintainers to communicate and collaborate; initially this will be a Slack channel.

Standards for measuring the quality of repositories will be rolled out across all repositories. These standards can benefit from work done at edX to measure repository health.

  • No labels