InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

[Pattern Idea] Maintainer Apprentice

Aperta
#670 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

:book: Type - Content Work :bulb: Early Idea 1-initial
Lingua principale
HTML
Stelle
853
Fork
206
Merge medio
1g 23h
PR unite (30g)
2

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dall’issue #670 e dall’istanza nota collegata #669, quindi esamina il contesto di CODEOWNERS e dei ruoli personalizzati del repository descritto nell’issue. Un pattern completo dovrebbe completare la sezione incompiuta Resulting Context e documentare chiaramente il problema maintainer-apprentice, i compromessi, le soluzioni e il risultato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github, markdown
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.