InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
[Pattern Idea] Maintainer Apprentice
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- HTML
- Estrelas
- 853
- Forks
- 206
- Merge médio
- 1d 23h
- PRs com merge (30d)
- 2
Descrição
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.
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
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pelo issue #670 e pela instância conhecida vinculada #669; em seguida, revise o contexto de CODEOWNERS e das funções personalizadas do repositório descrito no issue. Um padrão completo deve resolver a seção inacabada Resulting Context e documentar claramente o problema entre maintainer e apprentice, os trade-offs, as soluções e o resultado.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- github, markdown
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100