skillup

技術ブログ

Git ドキュメント作成

Gitの活用に関して

投稿日:

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

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

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

  • feature/XXX
  • feature_XXX

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

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

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

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

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

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

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

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

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

他にも参考リンクを。

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

-Git, ドキュメント作成

執筆者:


comment

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

関連記事

no image

Gitデタッチ、インデックス、プッシュなど

まとまってませんが、Gitであったトラブルについてのメモです。 Contents1 デタッチ状態2 インデックス一覧&削除2.1 インデックスの一覧2.2 インデックスから取り除くとき3 git pu …

no image

githubのremoteリポジトリへの登録

githubにgit pushしようとしたときにエラーがでたんでちょっとメモ。 githubに登録する場合、設定が適切でないと、

など …

no image

仕様の把握で見るポイント

新しい現場に入って技術的な部分はもとより仕様の把握などでポイントになる点などを。 Contents1 ER図2 ステータス変更3 プレイヤー(イベント)整理4 タイムテーブル5 マトリックス表6 ダミ …

no image

ファジープロジェクト対策 その1

5月ぐらいから着手していたプロジェクト(顧客管理ソフト)が終焉を迎え、検証段階に入ったので、記して置きたいことなど。 数ヶ月程度ですが、自分が携わったプロジェクトの中では過去最大クラスのものでした。 …

no image

最新版のgitをソースから&git diffおさらい

Contents1 gitをソースから2 git diff gitをソースから gitはyumから入れてもいいんですが、バージョンが古かったりすると機能がいろいろと制限されるなどのデメリットもあります …