2014年6月18日のブックマーク (3件)

  • 提言: コミットメッセージの一行目には要求仕様を書け - Qiita

    これは Git (や Subversion などのバージョン管理システム) にコミットする時により良いコミットメッセージを書くための提言です。この提言は特にメッセージの一行目だけを対象とします。せめて最も重要な一行目だけでも良いメッセージを書いて欲しいからです。提言をズバリ一言で表すと 一行目には要求仕様を書け です。 背景 プロジェクトによっていろいろ慣習の差はあるものの、一般的には「コミットメッセージの一行目は変更内容の要約を簡潔に書け」とされます。特に Git は、各コミットメッセージの一行目だけを取り出してそれを一覧表示するなど、一行目を特別に処理する機能が多いので、一行目にできるだけ多くの情報を凝縮させることは重要です。またメッセージを一行しか書かない不届きな慣習のプロジェクトでは、十分な情報を持たないメッセージは無用の長物と化します。 良くないコミットメッセージ しかし私は、情

    提言: コミットメッセージの一行目には要求仕様を書け - Qiita
    paz3
    paz3 2014/06/18
    良いコミットメッセージは、そのコミットによってプログラムがどんな要件を満たすのかをプログラムを主語とする動詞句(原形・命令形)で書く。するとFixedやChangedは不要になる/ブコメにFixやAddは必要という意見も。
  • なんかかっこいいプレゼンテーションテンプレートを探しているならreveal.js使ってみろって - Qiita

    ちょうどいくつかプレゼン用の資料を作らなきゃと思っていてなんかいいテンプレートないかな〜って探していたらのでreveal.jsが超絶に良かったのでメモ reveal.js htmlで綺麗でカッコいいプレゼンテーションを作れるフレームワークです。 3Dでグィングィン動きます デモ画面見ればどんな風にグィングィン動くかわかります(開いたら右スクロールボタンを押してみてください) Escキー押すとプレゼンテーションのドキュメント一覧が見れます それがまたカッコよく3Dでみれます。 PDFへのエキスポートが楽チンです 書いたドキュメントをプリントしてメンバーに配布とかってシーンがあるとおもいますが reveal.jsなら綺麗にできます。 使い方 zipパッケージで落としてくる hakimel/reveal.jsにいって 「Download ZIP」をポチッと押します。 書きたい内容をindex.h

    なんかかっこいいプレゼンテーションテンプレートを探しているならreveal.js使ってみろって - Qiita
    paz3
    paz3 2014/06/18
    Webブラウザでプレゼンテーションできるテンプレートreveal.jsの紹介記事。3Dでグィングィン動く。PDFに綺麗に出力できる。
  • モデルやメソッドに名前を付けるときは英語の品詞に気をつけよう - Qiita

    はじめに 他の人が書いたコードを読んでいるときに時々気になるのが、英語の間違いです。 特に動詞、名詞、形容詞の使い分けが間違っていたりすると、かなり違和感を感じます。 そこで今回はモデル(=クラス)やメソッドに名前を付けるときの基的な原則をまとめてみます。 また、英文法的に正しい品詞が選べるようになるための習慣についても最後に説明します。 想定する言語/フレームワーク この記事の説明ではRuby/Ruby on Railsを想定しています。 ただし、基的な考え方は他の言語でも同じように使えるはずです。 モデルの名前は名詞にする 例: 「支払い情報」を表すモデルを作りたい場合 × Pay ○ Payment 「支払う = payか。よし。」でモデルを作ってはいけません! payは動詞で、payの名詞形がpaymentです。 Payモデルではなく、Paymentモデルを作りましょう。 例:

    モデルやメソッドに名前を付けるときは英語の品詞に気をつけよう - Qiita
    paz3
    paz3 2014/06/18
    識別子名の品詞を意識することで読みやすいコードになる。モデルの名前は名詞、2単語は形容詞+名詞 or 名詞+名詞、メソッドは動詞(+名詞)、不可算名詞の使用を避ける、不安だったら極力辞書を引く。