search

output-cms / output-cms-frontend

Apache License 2.0
0 stars 0 forks source link

CONTRIBUTING.md #2

Open tingtt opened 1 year ago

tingtt commented 1 year ago

開発方針のすり合わせ

項目

ドキュメント化

n4rvs3 commented 1 year ago

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

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

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

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

tingtt commented 1 year ago

ブランチ

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

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

コミット

フォーマット

# 例: 機能に関するコミット
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

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

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