skillup

技術ブログ

Git ドキュメント作成

Gitの活用に関して

投稿日:

今回はgitの技術的なことではなく、主に運用に関して。超基礎的なことですが、チームで開発する場合にはルールを徹底してないと混乱をきたします。

ブランチを追加機能ごとにきる

当たり前ですが、featureブランチの運用に関して、追加機能ごとに以下のようなブランチを切って運用しましょう。命名はディフォルトのgit flowを使っても良いですし、以下のようにお手製で作っても良いと思います。

  • feature/XXX
  • feature_XXX

XXXには機能名を英字でも良いですが、何らかのタスク管理ツール(Redmine,Backlog)で管理している場合は通し番号を入れるのが一番いいと思います。(あとで振り返った時に動きを追うことができる)

あとはリーダーの方に見ていただくときにプルリクエストの発行すればOKですね。

バグに関してはhotfixブランチできる

featureブランチと同じですが、バグに関しても上記同様のブランチを切っておきましょう。

基本的に追加機能と同じようなルールで作って良いと思いますが、追加仕様と比べると粒度が小さくなりがちなので、超低粒度のものに関してはコミットメッセージで分類した方がいいかもしれません。

適切なcommitメッセージの書き方

こちらに関してもどんな修正をしたかが一目でわかることが大事ですので、

  • どんな修正なのか(追加仕様か、バグか、機能改善か)・・ブランチの切り方やルールが曖昧な場合はコミットメッセージで分類した方がわかりやすいでしょう。
  • タスク管理ツールを使っていれば参照番号など

などの情報がわかれば良いかと思います。

他にも参考リンクを。

僕が考える最強のコミットメッセージの書き方

-Git, ドキュメント作成

執筆者:


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

関連記事

no image

gulpに関して

gulpに関しての復習と色々と間違っていたところもあるのでまとめ。 ちなみに以前書いた記事は下記 gulpインストールとタスクの実行 Contents1 インストール2 タスクの実行3 npxコマンド …

no image

障害報告などでの伝える情報の視点

障害の重要度(後続タスクにブロックがあるかいなか)、調査原因(仕様不理解、設計考慮もれ、ケアレスミス)、影響度(画面単位などで) 障害が起こっているデータ(あるいはスクショなどで伝えられるか) 再現プ …

no image

外結〜運用フェーズでの気をつけることなど

外結以降のフェーズで注意することなど。(主に障害発生時の原因切り分け) Contents1 エラーの情報伝達に関して2 ログの見方3 デプロイ4 タスクコミュニケーション(タスク管理ツール) 主にスト …

no image

プログラムからとExcelからのテストデータ作成

テストデータの作成ですが、プログラムから作成するケースとExcelからシコシコ作ってSQLをがんと入れる場合があります。Excelつってもマクロを使ったりするんでプログラムですし、実際にはPHPとEx …

no image

テスト環境のデータ作りに関して

単体テスト以降の環境ですとテストのデータを作ることがなかなか大変だと思います。マスタなどはそのままもらうこともあると思いますので、主にトランザクションデータについて。 以前もこのネタに関しては色々書い …

アーカイブ