skillup

技術ブログ

Git ドキュメント作成

Gitの活用に関して

投稿日:

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

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

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

  • feature/XXX
  • feature_XXX

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

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

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

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

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

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

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

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

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

他にも参考リンクを。

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

-Git, ドキュメント作成

執筆者:


comment

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

関連記事

no image

GitLabのWebhook

前回の記事でGitLabのCI/CDを特集しましたが、実は今回やりたかったのはそこまで大掛かりなCIではなく、プッシュ時にオートマージ、オートデプロイなどでしたので、もっと簡単な仕組みでできます。 例 …

no image

ドメイン決定&業務フローとの対応確認

Contents1 ドメイン決定2 業務フローとの対応2.1 実際の業務とエンティティ、画面の遷移2.2 ドメインのCRUD分析 ドメイン決定 業務フローを抽出し、エンティティを抽出した段階で次にドメ …

no image

使える設計書作成に関して

私自身、この仕事を7〜8年やっておりますが、設計書作成については常に悩まされておりました。 設計書のメリット・デメリットとしては以下のようなものですかね。 メリット メンバー間での仕様の認識を統一でき …

no image

Officeソフトで覚えておきたいポイント(Word,Excel)

えー実は今現在、仕事でコードを書くことはほとんどしておらず、ExcelやWordと日々格闘しております。Excelも表計算じゃなくて図を書くのに使ってます。 ExcelはまだしもWordってエンジニア …

no image

gitの紹介と基本的な使用法について

Contents1 旧来のソース管理方法2 バージョン管理ツール2.1 バージョン管理とは?2.2 有名なバージョン管理ソフト3 Gitの基本的な使用法3.1 初期化(git init)3.2 基本的 …