開発ルール
概要¶
本ドキュメントはプロダクト開発を進める上で厳守すべきルールをまとめています。
プロダクトに求められる要件についても紹介しているので、必ず熟読してから開発してください。
設計・テストポリシー¶
設計規約¶
プロダクト単位の設計規約は設けていません。
少なくとも数年は仕様変更及びメンテナンスされることを想定し、技術的負債をなるべく残さない設計を心がけましょう。
テスト規約¶
ソフトウェアテストの必要性がわからない人は各自で調べてください。
テストを書いて幸せな開発ライフを送ろう！
- 単体テスト(WANT)
- メソッドなどコンポーネント単位のテスト
- いわゆるホワイトボックステストで、カバレッジを最大化することが求められる
- c0、c1 は 100%となるようにし、c2 はできれば 100%を目指してもらいたい
- 結合テスト(MUST)
- 機能ごと(=API エンドポイント単位)のテスト
- いわゆるブラックボックステストで、正常系、異常系の両方のテストが求められる
- E2E テスト(OPTIONAL)
- 画面ごとのテスト(UI テストとも呼ばれる)
- どうせ手動で確認するので、本プロジェクトは E2E テストを書いていない
プロダクト要件¶
Membership Console のマイクロサービスは必ず下記ドキュメントの要件を満たす必要があります。
必要に応じてドキュメントを更新しながら開発を進めてください。