InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

[Pattern Idea] Maintainer Apprentice

Offen
#670 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

:book: Type - Content Work :bulb: Early Idea 1-initial
Vorherrschende Sprache
HTML
Sterne
853
Forks
206
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
2

Beschreibung

Title

Maintainer Apprentice

Patlet / Summary

A user wants to work their way into becoming an Approver/Maintainer on an InnerSource repository while being given enough permissions to prove their contributions.

Problem

Sometimes a repository may want to "onboard" maintainers without giving them full write access. This means they are added to a repository to provide content/changes and able to "approve" other changes but not merge them. This could be a form of onboarding or internship on the way to approver or maintainer roles.

Context

From @spier in #669

...our idea with the lower section of the CODEOWNERS file was, that those folks doing the translation work might sort of be "maintainer apprentice", and through their involvement in the project become maintainers eventually

In this particular situation the user was in the CODEOWNERS file but did not have write permissions on the repository. This caused GitHub to label the CODEOWNERS file as having errors.

image

Forces

What could make this problem difficult?

  • the permissions structure in the organization or repository is not present to solve this

Tradeoff(s):

  • Knowing a "maintainer apprentice" is given enough permissions to contribute and approve but not merge changes.

Solutions

Any of the following:

  • Make sure all reviewers/approvers/maintainers of repositories have write permissions
  • Accepting that not all reviewers/approvers/maintainers of repositories have write permissions until earned
  • Custom repository or organization roles (if the software allows it) (e.g, Custom Repository Roles)

Resulting Context

What is the situation after the problem has been solved?
The original context is changed indirectly by way of the solution.
Often this section can include discussion of the next possible Patterns/problems introduced.
This section can be short in content - the solution may not introduce new problems or change much context.

Known Instances (optional)

#669

Status

Initial

Author(s) (optional)

@spier
@jmeridth

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit Issue #670 und der verlinkten bekannten Instanz #669 und prüfe anschließend den im Issue beschriebenen Kontext von CODEOWNERS und benutzerdefinierten Repository-Rollen. Ein vollständiges Muster sollte den unvollständigen Abschnitt Resulting Context vervollständigen und das Problem zwischen Maintainer und Apprentice sowie die Abwägungen, Lösungen und das Ergebnis klar dokumentieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github, markdown
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.