Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 2.58 KB

MAINTAINING.md

File metadata and controls

37 lines (29 loc) · 2.58 KB

Maintaining the REPL

This document is intended to help maintainers of the REPL.

What is there to do?

The following are merely suggestions to be built upon. Feel free to suggest new ideas!

I am a maintainer

  • The contributing guidelines list the main areas of maintenance.
  • The start date of each new semester is added to a script.
  • New contributors are added to the contributors list.
  • Pull requests are merged.
  • Companion repositories are kept-up-to-date.
  • Projects are kept up-to-date as needed.
  • Communication happens in known channels.
    • The #repl channel on Slack.
    • In issues.
  • If I am actively willing to help maintain the REPL, I am listed as a maintainer in the Maintainers team so others know they can reach out to me.
    • In addition, the 🚧 emoji is shown under my name in the contributors list (or removed, as needed).
      • Removing a contributor: Remove maintenance from under your name in all-contributorsrc, then let all-contributors clean up the README on the next use of the bot or delete the HTML by yourself in the README (careful with start/close tags in that case! You may want to double-check with a tool like https://validator.w3.org/).
      • Adding a contributor: e.g., comment @all-contributors please add @maintainer for maintenance in an issue or pull request.

I am an owner

The same as a maintainer, plus:

  • I can make sure that the Maintainers team is up-to-date.
  • I can create any team that is needed to split concerns, e.g. to manage a single repository.
  • I can give maintainer access to other students as I see fit.
  • After discussing with the other owners (the #repl channel on Slack is a good place to do so transparently), I can add new owners and remove inactive people as well (security!).
  • I may enable/disable GitHub features as needed. For example, I may enable GitHub Discussions if the consensus is that it is a good idea.
  • I can archive old and unused repositories if there's a need to keep things tidy.
  • I can do evil things, but I won't. 😉