InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
[Pattern Idea] Maintainer Apprentice
まだ誰も着手していません。
- 主要言語
- HTML
- スター
- 853
- フォーク
- 206
- 平均マージ
- 1日 23時間
- マージ済み PR(30日)
- 2
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず issue #670 と、リンクされている既知の事例 #669 を確認し、次に issue で説明されている CODEOWNERS とカスタムリポジトリロールのコンテキストをレビューしてください。完全なパターンでは、未完成の Resulting Context セクションを完成させ、maintainer と apprentice の間の問題、トレードオフ、解決策、結果を明確に文書化する必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- github, markdown
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100