nDiki : Naney Revision Control Guidelines

Naney Revision Control Guidelines

Naneyリビジョン管理ガイドライン

開発作業

  • その日の作業を始める前にリポジトリからアップデートをかけよう。
  • チェックアウトした作業ディレクトリで作業しよう。それ以外のところにコピーして編集するのはやめよう。
    • チェックアウトしたファイル/ディレクトリを別の場所にコピーして編集し、作業ディレクトリに戻すようなことはしない。そのような手順だと、他の開発者の変更に気がつかず古いファイルでまた上書きしてしまうかもしれない。
  • こまめにリポジトリからアップデートをかけて、他のメンバの更新に追従しよう。
  • 1日の作業終了時に(コミット可能な状態ならば)、コミットしよう。そうでないとあなたより遅く帰る人があなたの作業内容を知らないままコミットしてしまうかもしれない。

コードの変更

  • API (メソッド、関数名、引数仕様……)を変更する場合は、プロジェクト内の呼び出し側もきちんと変更しよう。あるいは、古い API も残しておいてきちんと動くようにしておくこと。古い API は deprecated マーカーをつけておくこと (cf. コーディング規約)。

コミット

  • コミットする前に、まずリポジトリからアップデートをかけて衝突していないか確認しよう。
  • コンパイルが通る状態でコミットしよう。
  • make check (make test) が通る状態でコミットしよう。 (cf. 単体テストガイドライン)
  • ログメッセージをきちんと書こう。
  • コーディング規約に従って整形してからコミットしよう。
  • こまめにコミットしよう。
    • ハードウェア障害等による、作業ファイルのロスト対策
    • 衝突対策
    • 作業状況の相互確認
    • 適切なコミットログがかけよう

ログメッセージ

コミュニケーション

  • リビジョン管理システムだけに頼らず、口頭などでこまめにメンバと連絡をとりあおう。

スポンサード リンク

no diary

About Me

Naney Naney (なにい)です。株式会社ミクシィでマネージャー・プロダクトオーナーをしています。

nDiki1999年1月に始めたコンピュータ日誌を前身とする NaneyWeb 日記(兼パーソナルナレッジベース)です。ちょっとしたノートは nNote にあります。

follow us in feedly

※内容は個人的見解であり所属組織とは関係ありません。

月別インデックス
Process Time: 0.10068s / load averages: 0.59, 0.62, 0.61
nDiki by WATANABE Yoshimasa (Naney, Google profile)
Powered by DiKicker