CONTRIBUTING.md

開発者向けドキュメント

インストールが必要なアプリケーションについて

このWebページの開発に参加する場合は以下のアプリケーションが必要です。
※Windows/Mac/Linuxのどちらでも開発できます。

• Node.js LTS (最新版)
• pnpm (with corepack)
• git

はじめてこのプロジェクトの開発に参加する方へ

1. まず、インストールが必要なアプリケーションを全てインストールしてください。
2. 管理者権限でコマンドプロンプト/PowerShell/ターミナルを開き、corepack enableを実行してください。
3. プロジェクトフォルダに移動し、pnpm iを実行してください。

Note 環境によってはデフォルトでnpmがインストールされますが、このプロジェクトではpnpmを使用します。 npmは使用しないでください。

開発用サーバーを起動する

pnpm dev で開発用サーバーが立ち上がります。
http://localhost:5173/ にアクセスすると、手元のコードからビルドされた最新のページを見ることができます。
(ホットリロード機能があるので、ファイルを編集するたびに起動し直さなくても良いです。)

ブランチ/コミット/Issue/Pull Request命名規則

プルリクエスト、コミット、Issueの名前は以下のようにしてください。
<type>: <title> (例: feat: Q＆Aページの作成)

• type:
  • fix: バグ修正、内容の更新、依存関係の更新 など
  • feat: 新しいページの作成、新しい機能の追加 など
  • chore: 軽微な修正(タイプミス修正など)
  • refactor: リファクタリング(プログラム内部の改善)
  • docs: ドキュメント関連の作業 など
• title:
  • 短い言葉で、内容を書いてください。

ブランチの名前は以下のようにしてください。
<type>/<issue-number>-<title> (例: feat/10-q-and-a)

• type:
  • 上と同じです。
• issue-number:
  • Issue番号を書いてください。
  • 複数のIssueにまたがっている場合は、どちらか片方の番号を書いてください。
• title:
  • 基本的には上と同じです。
  • 適切な位置でハイフンを入れることをおすすめします。