Versions Compared

Key

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

These are playbooks for on-call tasks. Feel free to add more!

...

  1. Set the Account Name to the relevant Institution(2U/edx, OpenCraft, etc.)

  2. The contributor's first and last name

  3. The contributor's GitHub username (case sensitive - it should match what you see on their profile at https://github.com/<username>)

  4. Ideally, their email address

  5. Locate the field Contributor Covered Under Entity and select it

  6. Locate the Role field and add the Entity Contributor role to the user.

...

You can copy-paste these runbooks directly into a GitHub ticket and get the lil checkboxes.

You should have access to the Core Contributor course on the training site. Please add the new CC to the course.

...

In most cases if the purpose of the repo is related to the Open edX Project, you should create the repo. If it turns out that the repo should not be a part of the openedx org, it is a lot easier to move the repo out than it is to move it in. Use your best judgement and if Ask ask in Slack or at standup if you’re unsure.

The GH request should include a suggestion for which team will maintain the repo. Before agreeing to create a new it, get confirmation from someone on that team that they will commit to maintain the new repo. Inform them that they can reach out in #wg-maintenance Slack channel if they would like to get involved as a maintainer right away; otherwise, their maintenance responsibilities will begin later in the pilot process or once the maintainership program fully kicks offEstablish who the maintainer will be before creating the repo. The requester’s first contribution should be to set the maintainer in catalog-info.yml. Ask them to join the #wg-maintenance Slack channel and give an FYI that a new repository exists and that they are the maintainer of it.

When creating a new repo, you may need to give several accounts establish some initial access. Don’t add users directly--give teams access to the repo instead.

...

  • cla-checker - write access

  • openedx-triage - triage access

  • wg-security - read access (this is managed automatically – nothing for you to do)

Depending on the language and purpose of your repo you may also need to add various additional bot users. You can search for all relevant bot teams by searching “bot-” but an example of Python bots is:

  • bot-release-pypi - write access

  • bot-requirements-python - write access

Finally, if a repo is meant to only hold issues (that is: only a README, catalog-info, gitignore, and GH workflows; NO code, docs, or assets), then click the gear next to the repo’s description and apply the issues-only topic. Then, to ensure that all Coding CCs can flexibly work with issues on the repo, grant:

  • core-contributor-program-committers - write access

🏗 Transferring repositories into openedx

...