命名規則 - sakataku1991/primal GitHub Wiki

プロジェクト関連

ドメイン名

  • xxxx.primal.com（xxxxにはapi・admin等が入る）

リポジトリ名

  • primal

※モノレポを採用

エンドポイント名

  • スネークケース（xxxx_xxxx）
  • 複数形

環境変数名

  • スクリーミングスネークケース（XXXX_XXXX）

GitHub

ブランチ名

  • 「feature/」+ issueの番号（feature/xxx）
    • 例）feature/56

PR名

  • PBIチケット（issue）のタイトル
    • 例）管理画面：「ログイン」ページを実装する

AWS

ユーザー名（※ IAM ユーザーではない！ ユーザーは IAM Identity Center で作成する！）

  • ケバブケース（xxxx-xxxx）
  • PRUMの開発メンバーであれば、「primal- + ローマ字の名 + - + ローマ字の姓」という命名にすること
    • 例）sakataku1991

許可セット（IAM ポリシー）名

  • アッパーキャメルケース（XxxxXxxx）
    • 例）AdministratorAccess

DB

DB名

  • スネークケース（xxxx_xxxx）
    • 例）primal

テーブル名

  • スネークケース（xxxx_xxxx）
  • 複数形

カラム名

  • スネークケース（xxxx_xxxx）

Rails

プロジェクトネーム

  • primal

ディレクトリ名

  • スネークケース（xxxx_xxxx）

マイグレーションファイル名

  • スネークケース（00000000000000_create_xxxx_xxxx.rb）
  • 複数形

モデル名

  • スネークケース（xxxx_xxxx）
  • 単数系

モデルクラス名

  • アッパーキャメルケース（XxxxXxxx）
  • 単数系

コントローラ名

  • スネークケース（xxxx_xxxx）
  • 複数系

コントローラクラス名

  • アッパーキャメルケース（XxxxXxxx）
  • 単数系

メソッド名

  • スネークケース（xxxx_xxxx）

定数名

  • スクリーミングスネークケース（XXXX_XXXX）

変数名

  • スネークケース（xxxx_xxxx）

params のパラメーター名

  • スネークケース（xxxx_xxxx）
    • 例）param: admin_id

Nuxt

プロジェクトネーム

  • 管理画面
    • primal-admin
  • ユーザー画面
    • primal-user

ディレクトリ名

  • ケバブケース（xxxx-xxxx）

パス名

  • パス名（ディレクトリ名）における id は 「リソース名」＋「Id」の形式で書くこと！
    • 例） 管理画面の「管理者の編集」ページ
      • src/pages/companies/[companyId]/recruiters/[recruiterId]/edit.vue`

ファイル名

  • ローワーキャメルケース（xxxxXxxx）
  • index.vue
  • pages配下にあるファイル

コンポーネントファイル名

  • アッパーキャメルケース（XxxxXxxx）
  • Button.vue

※コンポーネントを呼び出す際にもアッパーキャメルケースで統一する！

コンポーネント名

  • アッパーキャメルケース（XxxxXxxx）

メソッド名

  • ローワーキャメルケース（xxxxXxxx）

定数名

  • スクリーミングスネークケース（XXXX_XXXX）

変数名

  • ローワーキャメルケース（xxxxXxxx）

HTMLのclass名

  • ケバブケース（xxxx-xxxx）

※基本的なデザインはTailwind CSSを使用する ※複雑なデザイン等はケバブケースのクラス名で対応する

HTMLのid名

  • ケバブケース（xxxx-xxxx）

画像ファイル名

  • スネークケース（xxxx_xxxx）

自動配信メール

件名（＝メールのタイトル）

  • サービス名 ＋ メール本文の簡潔な要約
    • 例） 【primal】仮登録完了のお知らせ