<p>現在、GitHub Organization (Free) を活用してチーム開発を行っているが、無料版という制限の中で、どう運用 (妥協) しているのかなど、設定と運用ルールを書いていく。</p>
<aside class="msg message"><span class="msg-symbol">!</span><div class="msg-content">
<p>試行錯誤を重ねながら運用ルールを変えていったりしているので「私のOrganizationではこんな設定/運用しているよ！」みたいなのがありましたら、Discussionに書いてもらえると幸いです。</p>
</div></aside>
<h1 id="organization%E3%81%AE%E8%A8%AD%E5%AE%9A">
<a class="header-anchor-link" href="#organization%E3%81%AE%E8%A8%AD%E5%AE%9A" aria-hidden="true"></a> Organizationの設定</h1>
<h2 id="%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AAvisibility">
<a class="header-anchor-link" href="#%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AAvisibility" aria-hidden="true"></a> 基本的なVisibility</h2>
<ul>
<li>RepositoryやPackage (未使用)、Projectの <code>Visibility</code> は <code>Private</code>
</li>
<li>Peopleは <code>任意</code> (GitHubのプロフィールにOrganizationを表示する or 表示しない)</li>
</ul>
<h2 id="people-(%E6%8B%9B%E5%BE%85%E6%96%B9%E6%B3%95)">
<a class="header-anchor-link" href="#people-(%E6%8B%9B%E5%BE%85%E6%96%B9%E6%B3%95)" aria-hidden="true"></a> People (招待方法)</h2>
<p>Organizationに所属する全てのユーザを <code>Member</code> として招待する。</p>
<h2 id="team">
<a class="header-anchor-link" href="#team" aria-hidden="true"></a> Team</h2>
<p>Organizationには、<code>Team</code> という概念があり、これはDiscordでいう <code>ロール</code> のようなもの。<br>
<code>Team</code> に対して、アクセス権限の設定やメンションを行うことが可能。</p>
<p>現在は以下の設定を行っている。</p>
<div class="code-block-container"><pre><code>Team
├─member (内部のユーザ用)
│   └─developer (内部のユーザの中で開発に関わるユーザ用)
└─teacher (教員 (外部のユーザ用))
</code></pre></div><p>学生なので、チーム開発に関わる教員 (外部のユーザ) に対し、Read権を与えるために <code>teacher</code> を作成。<br>
(良いTeam名が思いつかないので <code>teacher</code> としている)</p>
<h2 id="settings">
<a class="header-anchor-link" href="#settings" aria-hidden="true"></a> Settings</h2>
<p>特に書いていない部分はデフォルト設定。</p>
<h3 id="member-privileges">
<a class="header-anchor-link" href="#member-privileges" aria-hidden="true"></a> Member privileges</h3>
<h4 id="member-repository-permissions">
<a class="header-anchor-link" href="#member-repository-permissions" aria-hidden="true"></a> Member repository permissions</h4>
<p><code>Base permissions</code> は <code>No permission</code> (手動で権限を割り当てたい為)</p>
<h4 id="admin-repository-permissions">
<a class="header-anchor-link" href="#admin-repository-permissions" aria-hidden="true"></a> Admin repository permissions</h4>
<h5>Repository visibility change</h5>
<p><code>Allow members to change repository visibilities for this organization</code> は <code>☐</code> (PublicなRepositoryに変更出来ないようにようにする為)<br>
<code>Allow members to delete or transfer repositories for this organization</code> は <code>☐</code> (Repositoryを削除または転送出来ないようにする為)</p>
<h4 id="member-team-permissions">
<a class="header-anchor-link" href="#member-team-permissions" aria-hidden="true"></a> Member team permissions</h4>
<h5>Team creation rules</h5>
<p><code>Allow members to create teams</code> は <code>☐</code> (Teamを作成出来ないようにする為)</p>
<h3 id="security-%26-analysis">
<a class="header-anchor-link" href="#security-%26-analysis" aria-hidden="true"></a> Security &amp; analysis</h3>
<p>便利な機能は活用する方針。</p>
<p><code>Enable all</code> を全て押す (既存のRepositoryで有効化したい為)<br>
<code>Automatically enable</code> は全て <code>☑</code> (Repository作成時に有効化したい為)</p>
<h3 id="webhooks">
<a class="header-anchor-link" href="#webhooks" aria-hidden="true"></a> Webhooks</h3>
<p>今回のチーム開発では、コミュニケーション手段の1つとしてDiscordを採用しているのでWebhookで通知を受け取る設定をする。</p>
<p>受け取るイベントは以下の設定を行っている。</p>
<div class="code-block-container"><pre><code>☑ Check runs
☑ Code scanning alerts
☑ Discussions
☑ Forks (Forkを許可していないので届かないのが正解)
☑ Issues
☑ Organizations
☑ Projects (現時点でなぜか届かない/Discord側の対応待ち？)
☑ Project cards (現時点でなぜか届かない/Discord側の対応待ち？)
☑ Project columns (現時点でなぜか届かない/Discord側の対応待ち？)
☑ Pull requests
☑ Pull request reviews
☑ Repositories
☑ Repository imports
☑ Repository vulnerability alerts
☑ Secret scanning alerts
☑ Teams
</code></pre></div><h3 id="installed-github-apps">
<a class="header-anchor-link" href="#installed-github-apps" aria-hidden="true"></a> Installed GitHub Apps</h3>
<p>インストールしているGitHub Apps (一部)</p>
<ul>
<li>
<a href="https://github.com/apps/project-bot" target="_blank" rel="nofollow noopener noreferrer">project-bot</a><br>
IssueやPull requestなどのイベントをトリガーに自動でProjectのカードを作成/移動してくれる (めっちゃ便利)</li>
</ul>
<h1 id="organization%E3%81%AEproject">
<a class="header-anchor-link" href="#organization%E3%81%AEproject" aria-hidden="true"></a> OrganizationのProject</h1>
<h2 id="settings-1">
<a class="header-anchor-link" href="#settings-1" aria-hidden="true"></a> Settings</h2>
<p>特に書いていない部分はデフォルト設定。<br>
一括して設定する場所がなさそうなので、Projectごとに設定。</p>
<h3 id="options">
<a class="header-anchor-link" href="#options" aria-hidden="true"></a> Options</h3>
<p><code>Organization member permission</code> は <code>None</code> (手動で権限を割り当てたい為)</p>
<h3 id="teams">
<a class="header-anchor-link" href="#teams" aria-hidden="true"></a> Teams</h3>
<p><code>developer</code> は <code>Write</code><br>
<code>member</code> は <code>Read</code><br>
<code>teacher</code> は <code>Read</code></p>
<h1 id="repository">
<a class="header-anchor-link" href="#repository" aria-hidden="true"></a> Repository</h1>
<h2 id="%E5%85%B1%E9%80%9A%E8%AA%8D%E8%AD%98">
<a class="header-anchor-link" href="#%E5%85%B1%E9%80%9A%E8%AA%8D%E8%AD%98" aria-hidden="true"></a> 共通認識</h2>
<ul>
<li>
<code>main</code> ブランチ, <code>develop</code> ブランチでは <code>git push -f</code> しない</li>
<li>ブランチ作成者本人以外が使用していそうなブランチで <code>git push -f</code> する場合は関係する人に了承を得て、対応方法を伝える</li>
<li>Repository名やブランチ名は <code>英数字</code> と <code>ハイフン</code> のみ使用する</li>
<li>デフォルトブランチは <code>develop</code> ブランチにする</li>
</ul>
<h2 id="%E3%83%96%E3%83%A9%E3%83%B3%E3%83%81%E3%83%A2%E3%83%87%E3%83%AB">
<a class="header-anchor-link" href="#%E3%83%96%E3%83%A9%E3%83%B3%E3%83%81%E3%83%A2%E3%83%87%E3%83%AB" aria-hidden="true"></a> ブランチモデル</h2>
<ul>
<li>Initial commitした状態で <code>main</code> ブランチから <code>develop</code> ブランチを切る (初回のみ)</li>
<li>
<code>develop</code> ブランチから <code>feature/hogehoge</code> ブランチを切って実装開始</li>
<li>
<code>feature/hogehoge</code> ブランチから <code>develop</code> ブランチへマージが完了したら <code>feature/hogehoge</code> ブランチは削除する (意図的に残す場合を除く)</li>
</ul>
<h2 id="project">
<a class="header-anchor-link" href="#project" aria-hidden="true"></a> Project</h2>
<p>進捗管理に使用 (運用方法はお任せ)</p>
<h2 id="label%2C-milestone">
<a class="header-anchor-link" href="#label%2C-milestone" aria-hidden="true"></a> Label, Milestone</h2>
<p>運用方法はお任せ</p>
<h2 id="issue">
<a class="header-anchor-link" href="#issue" aria-hidden="true"></a> Issue</h2>
<p>テンプレートを基本的に導入する (必要な情報漏れを防いでコミュニケーションロスを軽減する為)</p>
<h2 id="pull-request">
<a class="header-anchor-link" href="#pull-request" aria-hidden="true"></a> Pull request</h2>
<p>テンプレートを基本的に導入する (必要な情報漏れを防いでコミュニケーションロスを軽減する為)</p>
<h3 id="pull-request%E3%82%92%E3%83%9E%E3%83%BC%E3%82%B8%E3%81%99%E3%82%8B%E9%9A%9B%E3%81%AE%E6%9D%A1%E4%BB%B6">
<a class="header-anchor-link" href="#pull-request%E3%82%92%E3%83%9E%E3%83%BC%E3%82%B8%E3%81%99%E3%82%8B%E9%9A%9B%E3%81%AE%E6%9D%A1%E4%BB%B6" aria-hidden="true"></a> Pull requestをマージする際の条件</h3>
<ul>
<li>Pull request作成者以外のレビュワーからApproveされている</li>
<li>CI等のチェックが通った (導入している場合)</li>
</ul>
<p>上記条件を満たした場合のみマージ可能 (無料版ではこのあたりの設定が出来ない)</p>
<h2 id="settings-2">
<a class="header-anchor-link" href="#settings-2" aria-hidden="true"></a> Settings</h2>
<p>特に書いていない部分はデフォルト設定。</p>
<h3 id="manage-access">
<a class="header-anchor-link" href="#manage-access" aria-hidden="true"></a> Manage access</h3>
<p><code>developer</code> は <code>Maintain</code><br>
<code>member</code> は <code>Triage</code><br>
<code>teacher</code> は <code>Read</code></p>
<h1 id="manual-repository">
<a class="header-anchor-link" href="#manual-repository" aria-hidden="true"></a> Manual Repository</h1>
<p><a href="#repository">Repository</a> のマニュアルが格納されている。</p>
<h2 id="%E7%9F%A5%E8%A6%8B%E5%85%B1%E6%9C%89%E3%82%84%E6%8A%80%E8%A1%93%E7%9A%84%E3%81%AA%E8%B3%AA%E5%95%8F">
<a class="header-anchor-link" href="#%E7%9F%A5%E8%A6%8B%E5%85%B1%E6%9C%89%E3%82%84%E6%8A%80%E8%A1%93%E7%9A%84%E3%81%AA%E8%B3%AA%E5%95%8F" aria-hidden="true"></a> 知見共有や技術的な質問</h2>
<p>本来Wikiを使いたかったが、無料版ではPrivateなRepositoryでの有効化が出来なった為、以下の対応を行っている。</p>
<h3 id="discussion">
<a class="header-anchor-link" href="#discussion" aria-hidden="true"></a> Discussion</h3>
<p>Discussionが有効化されており、知見共有や技術的な質問はここで行う (QiitaやZennのような使い方)</p>
<p>Categoryは以下の設定を行っている。</p>
<div class="code-block-container"><pre><code>Tips (知見共有)
Q&amp;A (技術的な質問)
</code></pre></div><h1 id="%E3%81%82%E3%81%A8%E3%81%8C%E3%81%8D">
<a class="header-anchor-link" href="#%E3%81%82%E3%81%A8%E3%81%8C%E3%81%8D" aria-hidden="true"></a> あとがき</h1>
<p>試行錯誤を重ねながら運用ルールを変えていったりしている状況だが、落ち着いてきたので文章化を兼ねてこの投稿を書いた。<br>
イレギュラーな運用方法も混ざっているとは思うが、より良い設定や運用ルールに改善していきたい思う💪</p>


【個人的】チーム開発におけるGitHub Organization (Free) の設定と運用ルール

Pull requestをマージする際の条件

meg_ssk

<p>ものすごく参考にしています、ありがとうございます！</p>
