CONTRIBUTING.md

[tingtt]

開発方針のすり合わせ

項目

• 設計指針
• フォルダ構成
• コミットメッセージフォーマット

ドキュメント化

• CONTRIBUTING.md の作成

[Rin-reboot]

認証の部分は状態管理だったりUIをどうするか要検討、contextを利用するのか状態管理ライブラリを使うのかでディレクトリ構造も変わってくる

取り急ぎ浮かんだのは以下、足りない部分は考えたい

- src
  - components
    - UI似関するコンポーネント周り
  - auth
    - 認証周り、supabaseを利用する場合はそんな複雑にならない
    - /pages/api 以下に認証apiを置く
  - lib
    - ライブラリの初期化ファイル等、supabaseとかPrismaもここ

[Rin-reboot]

コミットlintは使ったことないので良さげなのあれば教えてもらえたら使います！

[tingtt]

ブランチ

git checkout -b 'プレフィックス/ブランチ名'

プレフィックスはcommitlint で使用できるものと同様

• feat/* 機能追加
• fix/* バグ修正
• docs/* ドキュメント類
• chore/* 雑多
• ci/* CI
• etc.

コミット

フォーマット

• プレフィックス(機能名): 変更内容

# 例: 機能に関するコミット
git commit -m 'feat(markdown-editor): add'

# 例: バグ修正に関するコミット
git commit -m 'fix(markdown-editor): fix typo'

コミット時にはcommitlintによるコミットメッセージのチェック・huskyによるコード整形・テストの自動実行を行います。
使用できるコミットメッセージのフォーマットはonventional-changelog/commitlintのREADME.mdを参照してください。

使用できるプレフィックス

• build
• chore
• ci
• docs
• feat
• fix
• perf
• refactor
• revert
• style
• test

ディレクトリ構成（フォルダ構成）

ドメイン駆動設計・レイヤードアーキテクチャを採用しています。

• domain/ ドメイン層（ビジネスルール・仕様）
  • [モジュール名]/ 機能の実装
• application/ ユースケース層（ドメイン層を扱い、プレゼンテーション層への仲介を行う。）
• src/ プレゼンテーション層（ユースケース層を扱い、UIを形成する）
  • components/
    • .common/ 共通コンポーネント（AtomicDesign - Lv.1-2）
    • [コンポーネント名]/ （AtomicDesign - Lv.1-3）
  • templates/ - テンプレート（AtomicDesign - Lv.4）
  • pages/ - ページ（AtomicDesign - Lv.5）