Git ワークフロー

研究室での Git / GitHub の使い方・ブランチ運用ルールをまとめます。

Git ワークフロー

ブランチ命名規則

種別命名パターン
機能追加feat/説明feat/add-ros2-setup-page
修正fix/説明fix/broken-image-link
ドキュメントdocs/説明docs/update-welcome

基本的な作業フロー

# 1. 最新の main を取得
git switch main
git pull origin main

# 2. 作業ブランチを作成
git switch -c feat/add-my-page

# 3. ページを作成・編集
python tools/new_page.py "ページタイトル" --category knowledge

# 4. バリデーション
python tools/validate.py

# 5. コミット
git add content/
git commit -m "docs: add knowledge page on ..."

# 6. プッシュ & PR
git push -u origin feat/add-my-page
# GitHub で Pull Request を作成

コミットメッセージ規約

Conventional Commits に準拠します。

プレフィックス用途
docs:Wiki コンテンツの追加・更新
feat:新機能追加(テンプレート・ツール等)
fix:バグ修正
chore:その他メンテナンス
main への直接 push
緊急修正を除き、`main` ブランチへの直接 push は避けてください。 Pull Request を通じたレビューフローを推奨します。