From 3d8d7eb4a183de6e64494ce99d3757999b546586 Mon Sep 17 00:00:00 2001
From: Esurio <esurio@esurio1673.net>
Date: Mon, 29 Jul 2024 11:15:37 +0000
Subject: [PATCH] add development guide

---
 docs/DEVELOPMENT.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 docs/DEVELOPMENT.md

diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
new file mode 100644
index 0000000000..45b748e820
--- /dev/null
+++ b/docs/DEVELOPMENT.md
@@ -0,0 +1,45 @@
+# 開発ガイド
+開発をする上で役にたつメモ
+
+## devcontainerの利用
+開発をする上でdevcontainerを利用すると、コンテナ上に開発環境を構築することができます。
+
+> **Note**
+> Windowsを利用している場合、リポジトリをローカルにクローンする必要があります。
+  
+実行する前に下記のコマンドを打つ必要があります。
+```bash
+git clone https://github.com/1673beta/cherrypick.git
+chmod 777 cherrypick
+cp .devcontainer/devcontainer.yml .config/default.yml
+```
+その後、VSCodeのコマンドパレットからコンテナをビルドして立ち上げ、下記のコマンドを実行することで開発サーバーが立ち上がります。
+
+```bash
+pnpm build
+pnpm migrate
+pnpm dev
+```
+
+## DBマイグレーションを作成する
+Misskey/CherrypickではTypeORMを利用してDBマイグレーションを実行します。下記の手順で作成することができます。
+
+```bash
+cd packages/backend
+pnpm dlx typeorm migration:generate -d ormconfig.js -o MigrationName
+```
+
+## フォーマット
+Biomeを使ってコードフォーマットを統一することができます。
+下記ディレクトリで実行することができます。
+* packages/backend
+* packages/frontend
+* packages/cherrypick-js
+* packages/sw
+
+下記コマンドを実行すると、フォーマットを修正することができます。
+
+```bash
+pnpm run format:write
+```
+