メインコンテンツまでスキップ

コントリビュートガイド

Auriga Studio の開発に参加するためのルールです。

コーディングルール​

言語・スタイル​

  • Vanilla JS のみ。TypeScript・トランスパイラ・バンドラーを勝手に導入しない。
  • コメントはすべて日本語で書く。
// ✅ タイムラインの描画を初期化する
function initTimeline() { /* ... */ }

// ❌ Initialize the timeline rendering
function initTimeline() { /* ... */ }
  • セミコロンあり、インデントは 2 スペース（既存コードに合わせる）。
  • var は使わない。const / let を使う。

ファイル分割​

  • 1 ファイルに 1 つの責務を持たせる。
  • 機能が増えたら src/ に切り出すが、事前に方針を確認する。

Git ルール​

毎ターン（タスク完了ごと）に必ず commit & push します。

git add -A
git commit -m "feat: ○○を実装"
git push

コミットメッセージの形式​

<type>: <日本語で変更内容を簡潔に>
type用途
feat新機能
fixバグ修正
refactor動作変更なしのリファクタ
docsドキュメントのみの変更
choreビルド・設定変更など

やってはいけないこと​

  • TypeScript・Webpack・Vite などのビルドツールを無断で導入する
  • var を使う
  • コメントを英語で書く
  • タスク完了後に commit & push を忘れる
  • Premiere Pro の仕様が不明なまま無理に実装しようとする
  • ときくんくらうど！のストレージ設計をスケーリング計画なしに変更する
  • 既存ファイルのディレクトリ配置を勝手に変える

よく使うコマンド​

# Electron を起動して動作確認
npx electron .

# 変更をコミット & プッシュ（毎ターン必須）
git add -A && git commit -m "feat: ○○" && git push