Skip to content

docs: Git運用フローの整備#29

Closed
GOROman wants to merge 1 commit intomainfrom
feature/issue-28-git-workflow
Closed

docs: Git運用フローの整備#29
GOROman wants to merge 1 commit intomainfrom
feature/issue-28-git-workflow

Conversation

@GOROman
Copy link
Owner

@GOROman GOROman commented Mar 20, 2025

概要

プロジェクトルールに基づいたGit運用フローの整備を行いました。

関連Issue

変更内容

PRテンプレートの追加

  • プロジェクトルールに基づくチェックリスト
  • テスト要件の確認項目
  • コーディング規約の確認項目
  • デプロイメント手順の項目

Git運用フローのドキュメント作成

  • ブランチ戦略の詳細化
    • mainブランチの保護
    • feature/bugfix/hotfixブランチの運用
    • ブランチ命名規則
  • コミットメッセージの規約
    • 日本語での記述
    • 変更タイプの明確化
  • PRレビュープロセス
    • レビュー必須化
    • チェック項目の明確化
  • CI/CD連携の方針

テスト

  • ドキュメントの変更のみのため、テストは不要

コーディング規約準拠

  • ドキュメントはプロジェクトルールに従い作成
    • READMEおよび開発者向けドキュメント: 英語
    • コミットメッセージ: 日本語

破壊的変更

なし

デプロイメント

  • リポジトリ設定の変更が必要
    • mainブランチの保護設定
    • PRレビュー必須化
    • ステータスチェック必須化

その他

このPRをマージ後、以下の作業が必要です:

  1. GitHubのブランチ保護設定の有効化
  2. チーム全体への新しいGit運用フローの共有
  3. 既存のブランチの整理

- PRテンプレートの追加
  - プロジェクトルールに基づくチェックリスト
  - テスト要件の確認項目
  - コーディング規約の確認項目

- Git運用フローのドキュメント作成
  - ブランチ戦略の詳細化
  - コミットメッセージの規約
  - PRレビュープロセス
  - CI/CD連携

Issue #28 対応
@GOROman GOROman requested a review from Copilot March 20, 2025 07:08
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the project's Git operations by adding a detailed Git workflow guide and a standardized pull request template.

  • Added a comprehensive Git workflow document outlining branch strategy, development flow, commit message rules, and CI/CD integration.
  • Introduced a new pull request template to help ensure completeness and consistency in PR submissions.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/git-workflow.md New document detailing the Git workflow process.
.github/pull_request_template.md New PR template with instructions and checklists.
Comments suppressed due to low confidence (1)

.github/pull_request_template.md:6

  • [nitpick] The placeholder '- #' in the Related Issue section may be unclear; consider providing more explicit guidance or removing it if not necessary.
- #

@GOROman GOROman closed this Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants