skillup

技術ブログ

Git ドキュメント作成

Gitの活用に関して

投稿日:

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

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

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

  • feature/XXX
  • feature_XXX

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

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

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

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

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

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

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

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

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

他にも参考リンクを。

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

-Git, ドキュメント作成

執筆者:


comment

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

関連記事

no image

Git→Jenkinsの連携

気がついたら投稿数が50超えてましたね。 ガチンコ塾とあわせて更新してますが、2ヶ月ちょいなので結構いいペースで更新しているかと思います。 大切なのはこれを継続できるかですね。ただ、ガチンコ塾に比べる …

no image

git別リポジトリからの差分取りこみ、リモートの別ブランチ反映、強引なstash

gitについて最近覚えたことなど Contents1 別リポジトリからの差分取り込み2 別ブランチからファイルのみ取り込み3 追跡ブランチをローカルに取り込みたいとき4 強引なgit stash 別リ …

no image

業務管理アプリの商品コードに関して

一般的な業務管理アプリを作っていると商品や顧客などもオートインクリメントのidではなく、独自の仕様で決められた「商品コード」などを持っていることが一般的です。 昔通販がらみのシステムを使っている時も商 …

no image

EntityとValue Objectについて

ドメイン駆動設計に関して勉強しています。参考にしている本がやたら難しいんで、トピックごとにネットで調べつつ進めていくのがよさげです。 今回はEntityとValueObjectについて Content …

no image

データベースのテスト環境作成

現在作っているシステムのリリースが近づいており、本番に近い環境を作成しお客様に見てもらうことに。 こういった手順はマニュアル化しておいたほうが楽だろうと思い、自分的にメモ 1 現状運用されているデータ …