タグ

ブックマーク / hisaichi5518.hatenablog.jp (2)

  • Web APIを作るときに考えること。 - パルカワ2

    この記事はPepabo Advent Calendar 2014の11日目の記事です。 前日は、tnmtさんのVagrantのshell provisionerでApacheのビルド済tarボールをOSバージョン毎に作る術でした。 はじめに 今回は、Web APIを作るときに考えることをまとめました。 当は、社内向けに資料を作っていて、社内の勉強会とかで話せればいいか〜って考えていたんですが、アドベントカレンダーのネタが当になくて困っていたのでこれを使います。 対象者 APIを作る時、と書いてますが、クライアント側の人にとっても知っておく必要があることなので、サーバ側の人・クライアント側の人両方が対象者です。 APIを作るときに考えること 「APIを作るとき」と言っても、色んな状況があります。 まずはそれを絞ります。 APIの種類 プライベートAPI アプリのAPIなど使う人が限定され

    Web APIを作るときに考えること。 - パルカワ2
    hiro_y
    hiro_y 2014/12/11
  • コミットログを綺麗にする努力をする。 - パルカワ2

    綺麗なコミットログとは 綺麗なコミットログとは、コミットログを見返す時に知りたい事を知れる。 コミットログを見返す時は、「なにをしたのか」と「なぜその変更を行ったか」を知りたい。つまり、「なにをしたのか」と「なぜその変更を行ったか」を書けば綺麗なコミットログになると言える。 ファイルを変更した場合 一行目:「何」に「どういった」変更を行ったかを簡潔に書く(要約) 二行目:改行がないとおかしいことになるので、二行目は必ず改行する 三行目以降:一行目に書いた変更を「なぜ」行ったかを書く 例 HogeViewはpiyo時にfugaするように変更 fugaしないと〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜が起きて 〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜で 〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜なので フィードバックの対応などした場合 一行目、二行目は、変更した場合と同じ 三行目以降:フィードバ

    コミットログを綺麗にする努力をする。 - パルカワ2
    hiro_y
    hiro_y 2014/05/03
  • 1