開発ルール
本ドキュメントでは、本プロジェクトにおける 心得ておくべき開発ルールやコーディング規約について説明します.
- 常に全員がコードを理解することができるように心がけてほしいです.
- コードで分からないことがあれば、遠慮なく質問してください.
- Ruby on Railsで分からないことがあれば, Railsガイドなどの公式ドキュメントを初めに参照するようにしてください.
- 開発を行う際は新たなブランチを作成して開発を行うこと.
- プルリクエストを作成し、一名以上のレビュー後にマージすること.
- PRの単位は機能ごとに分けること.
- テストコードを必ず作成すること.
- 開発者ドキュメントを適切に更新すること.
- 更新方法は開発ドキュメントを参照.
コーディング規約
Section titled “コーディング規約”- 変数名・関数名・モデル名など、標準的な命名規則に従うこと. 参考
- RoboCopフォーマッタを適用すること.