github-repo
GitHub.comリポジトリのSettingsと運用ファイルについて、推奨設定の案内、診断、設定を行う。イミュータブルリリース、ブランチルール、Actionsの権限とロックファイル、セキュリティ機能、Dependabot、CODEOWNERS、Issue・PRテンプレート、参加手順や問い合わせ先の案内を扱うときに使う。通常のIssue・PR管理や、製品のパイプライン全体の設計には使わない。
SKILL.mdskills/github-repo/SKILL.md
GitHubGitHubリポジトリの設定とファイルを整備する
対象リポジトリを推奨プラクティスと比較し、適用対象の差分を説明して、依頼された変更を実施する。指定された一つのGitHub.comリポジトリを対象にする。リポジトリ内のパスは対象リポジトリを指し、同梱資料へのリンクはこのスキルのディレクトリを基準にする。
リポジトリのSettingsと、通常は .github に置く設定ファイルや貢献者向けのファイルを扱う。他の対応済みの場所に同等のファイルがある場合は尊重する。これらのプラクティスに必要なワークフローの変更も含めるが、依頼を製品固有のビルド、テスト、リリース、デプロイの設計まで広げない。
要件と前提条件
| 強度 | 意味 |
|---|---|
| MUST | 適用対象として採用したプラクティスで必須とする |
| SHOULD | 対象リポジトリに異なる設定を使う妥当な理由がない限り推奨する |
| MAY | 目的や運用に合う場合に任意で採用してよい。未採用を不備や未完了とは扱わず、例外承認も求めない |
これらはこのスキルの採用基準であり、GitHub全体の必須要件ではない。方針の衝突や例外を報告し、ユーザーが指定した範囲や、より強い既存の保護を上書きしない。MAYという分類だけでは変更は承認されない。既に採用した項目や採用を依頼された項目は、前提条件を満たし、変更後の結果を確認する。
- リポジトリで実際に使う機能、プラン、所有形態、ワークフローの実行経路から適用対象を判断する。利用できない機能や満たしていない前提条件を適合とは扱わない。理由を示し、それらに依存せず進められる作業を続ける。
- 操作に必要な権限を持つ、認証済みのGitHub連携、GitHub CLI、または対応するUIを使う。ファイルの変更にはGitと対象リポジトリの変更を届けるためのツールを使う。Actionsのロックには、同梱ガイドに従ってGitHub CLIと
github/gh-actions-lockも用意する。 - 同梱の参照資料とテンプレート類を、このファイルと一緒に保持する。インストールは手順を利用できるようにするもので、テンプレートの採用、Settingsの変更、書き込みの承認を意味しない。
依頼内容と担当範囲
対象の完全な owner/repo、求められる成果物、実行承認、対象リポジトリの方針を確認する。診断の依頼はファイルや設定の変更を承認するものではない。この基準を他のリポジトリのレビュー方針として外部レビュアーに課さない。方針が衝突する場合は、差分と選択肢を示す。
| 求められる成果物 | 進め方と終了条件 |
|---|---|
| 診断、比較、改善提案への回答 | 読み取りだけで調査し、根拠、判定、不確かな点を報告して終了する。Issueの投稿や設定変更を始めない |
| 計画や診断をIssueに記録するだけの依頼 | 計画を記録し、取得し直して内容の一致と表示を確認する。本文とURLを提示して終了する。設定は適用しない |
| 診断文書の保存 | 対象の形式と言語で依頼された報告書を保存する。Gitで管理する文書は承認済みのファイル変更の手順で届け、設定は適用しない |
| リポジトリファイルの追加・改善 | 承認済みのファイル変更に従い、既存の内容と対象リポジトリの変更手順の要件を保つ。ファイルの導入は、無関係なSettingsの変更を承認するものではない |
| 設定とファイルの適用・修正 | 承認を計画に記録し、前提となるファイル変更を完了する。その後、設定の適用手順に従って差分を適用し、再診断する。計画の提示だけで終了しない |
設定だけの変更では、空のコミットやPRを作らない。前提となるワークフロー、文書、実装ファイルを承認済みのファイル変更手順で届けてから、それらに依存する設定を強制する。必要なアクセスや操作手段がない場合は、該当操作を保留し、未完了の範囲を示して、可能な読み取りを続ける。取得済みの実行承認や確認済みの計画を、改めて求めない。
段階ごとの参照資料
診断では、まず操作と判定の調査・報告に関する部分を読む。その後は対象項目の資料だけを追加し、無関係な資料まで毎回すべて読み込まない。
| 条件 | 参照資料 |
|---|---|
| PRのタイトル・本文とマージメッセージの一致だけを診断、または承認済みの範囲で設定する | PRとマージコミットのメッセージを揃える。無関係な基準まで広げない |
| リリース、マージ、ブランチ保護、必須チェック、Actionsのポリシー | 設定基準 |
| 無料のセキュリティ機能、利用可否、課金、前提条件 | セキュリティ |
| Dependabot、CODEOWNERS、Issue・PRテンプレート、脆弱性の報告方針、参加手順、問い合わせ先 | リポジトリファイルと同梱テンプレート |
| Actionsの依存関係ロックファイルの導入・保守 | Actionsのロック |
| 設定の取得、差分の適用、失敗、競合、再実行、結果の確認 | 操作と判定 |
バージョンに依存する判断では、API、機能の利用可否、無料で使える条件、権限、UIの名称について、現在の公式仕様を確認し直す。確認結果は対象の診断に記録する。過去に確認したことだけでは、現在も適用できる根拠にならない。
共通の制約
- 公開・非公開、個人・Organizationの所有形態、デフォルトブランチ、権限、上位のポリシーを調べる。取得できない項目、欠落した項目、未対応の項目を「無効」や「適合」に置き換えない。
- より強い既存の保護、必須チェック、承認要件、同等の設定を保つ。導入先のブランチ名、RulesetのID、チェック名、パッケージエコシステム、担当者、報告先を固定値で埋め込まない。
- Organization、Enterprise、アカウント全体の変更、公開範囲の変更、権限の拡大、有料契約や試用の開始は対象外とする。費用が未確認の操作は保留する。
- 無関係な改善、脆弱性の一括修正、アラートの却下、修正PRの自動マージを含めない。無料機能の有効化と、その機能をマージ要件にすることは別々に判断する。
- 適用前後の根拠を残し、取得し直した結果と必要な振る舞いの確認に基づいて判定する。成功、未完了、任意・未採用、対象外、承認済みの例外を区別する。APIの成功応答だけでは完了としない。