📝 はじめに
こんにちは、piyovateです。
今回は GitHub のリポジトリを公開（Public）にする前に確認しておきたいポイントや、**公開後におすすめの設定（ブランチ保護）**について紹介します。
Qiitaやブログなどから GitHub を参照してもらう機会が増えてきたので、**「安全に公開するための手順」**を整理しておきたいと思い、この記事を書きました。
✅ 公開前に確認したいポイント一覧
| チェック項目 | 内容 |
|---|---|
| 🔐 認証情報の除外 |
.envやAPIキーなど、絶対に含めない |
| 📄 ライセンスの明記 | MITなどのOSSライセンスをREADMEとLICENSEに記載 |
| 📘 READMEの整備 | 概要・使い方・依存ライブラリ・注意事項を明記 |
| 🔒 ブランチ保護の設定 | 誤pushや誤マージを防止するためのGitHub機能 |
🔐 認証情報の除外
✅ やること
-
.gitignoreに.envや*.keyなどの機密ファイルを追加 -
git log -- .envなどで一度もコミットされていないことを確認 - 誤ってコミットした場合は
git filter-repo等で履歴ごと削除
git log -- .env
# → 出力がなければ未コミット
📄 ライセンスを明記しよう
GitHubではライセンスを明記しておくと、他の開発者が安心してコードを利用できます。
代表的なライセンスには以下のようなものがあります：
| ライセンス | 特徴 |
|---|---|
| MIT | 商用・改変・再配布すべてOK。著作権表記だけ残す必要あり |
| Apache 2.0 | MITに加え、特許条項もカバー |
| GPL | 派生物も公開必須。コピーレフトの思想に基づく |
✅ READMEへの記載例（MIT）
## 📝 License
MIT License
Copyright (c) 2025 Technosphere
This project is licensed under the MIT License.
See the [LICENSE](LICENSE) file for details.
📘 READMEの整備内容例
- プロジェクトの概要
- セットアップ方法（例：仮想環境・依存パッケージ）
-
.envファイルや API キーの説明（※中身は含めない） - ライセンスや利用上の注意事項
🔒 ブランチ保護設定のススメ
GitHubには、「誤って main/develop に直接pushしてしまう事故」を防ぐためのブランチ保護ルールがあります。
✅ おすすめ設定例（main や develop ブランチ）
| 設定項目 | 内容 |
|---|---|
| Require a pull request before merging | PR経由でしかマージできないようにする |
| Require approvals | 承認（レビュー）なしではマージ不可 |
| Prevent force pushes / deletions | 強制pushやブランチ削除を防ぐ |
| Do not allow bypassing | 管理者にもルールを強制する |
💡 注意：保護ルールが有効になる条件
- リポジトリが Public であれば、GitHub Free プランでも保護ルールが有効になります
- Privateリポジトリでは、保護ルールを有効にするには有料プランが必要な場合があります
✨ まとめ
GitHubでリポジトリを公開する際は、
- 誤って個人情報を含めていないか？
- 他人が安心して使えるように整備されているか？
- 開発の安全性を保つ設定がされているか？
このあたりをチェックしておくと、安全・安心・かっこよく公開できます！
それではまた次回の記事でお会いしましょう🚀