開発ルール - Roadagain/blackjack.rs GitHub Wiki
大まかな流れ
- Issueを作成
issue/XXX
でPull Requestを作成- baseは
master
- branch protectionでCI必須にしたい
- baseは
- レビューしてLGTMが出ればマージ
レビュー基準
エクストリームオブジェクト指向
参考: オブジェクト指向できていますか?
- 1つのメソッドにつきインデントは1段階まで
- else句を使用しないこと
- すべてのプリミティブ型をラップする
- 1行につきドットは1つまで
- 名前を省略しない
- すべてのエンティティを小さくする
- 1つのクラスにつきインスタンス変数は2つまで
- ファーストクラスコレクションを使用する
- Getter Setterを使用しない
よいコード
- YAGNI
- DRY
- SOLID
- 可読性の高さ
レビューされる側の心がけ
ちゃんとした対応をするよりパパっとやる
- 機能のコード的な部分にこだわるよりも、1回マージしてリファクタブランチ切る
- レビュー通らなさすぎてモチベが落ちることが一番危険
CIで実行すること
- ビルド
- テスト
- lint (with clippy)