# コーディング規則

## 直接ブランチにプッシュしないこと

必ず誰かのレビューを受けてからマージを行うことで責任を負いすぎないように。

## 変更は機能単位で行うこと

あまりにもボリューミーになる前に細かくコミットをすること。

例) ベクトル検索、OCR検索のように明確に異なるものを1つのプルリクエストで送らない。

## わかりやすい変数名を意識すること

例えばユーザーの年齢を表す変数に `age` ではなく `num1` などのようなものは使用しないように。

多少長くても明確にわかりやすい変数を使用すること。

## 動くことが大事

多少無理やりなコードでも動かないものより100倍よいので一度それでプルリクエストを送り、そのうえでレビューを受けて修正を行ってください。

## コミットのメッセージはわかりやすくすること

以下のリンクに書いてあるようにコミットメッセージを作成すること。

多分こっちのほうがわかりやすい。

<https://qiita.com/shisotem/items/8f8e11a426450828e5b7>

こっちはドキュメント

<https://www.conventionalcommits.org/ja/v1.0.0/>

\