開発ルール - Roadagain/blackjack.rs GitHub Wiki

大まかな流れ

  1. Issueを作成
  2. issue/XXX でPull Requestを作成
    • baseは master
    • branch protectionでCI必須にしたい
  3. レビューしてLGTMが出ればマージ

レビュー基準

エクストリームオブジェクト指向

参考: オブジェクト指向できていますか?

  1. 1つのメソッドにつきインデントは1段階まで
  2. else句を使用しないこと
  3. すべてのプリミティブ型をラップする
  4. 1行につきドットは1つまで
  5. 名前を省略しない
  6. すべてのエンティティを小さくする
  7. 1つのクラスにつきインスタンス変数は2つまで
  8. ファーストクラスコレクションを使用する
  9. Getter Setterを使用しない

よいコード

  • YAGNI
  • DRY
  • SOLID
  • 可読性の高さ

レビューされる側の心がけ

ちゃんとした対応をするよりパパっとやる

  • 機能のコード的な部分にこだわるよりも、1回マージしてリファクタブランチ切る
  • レビュー通らなさすぎてモチベが落ちることが一番危険

CIで実行すること

  • ビルド
  • テスト
  • lint (with clippy)