summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2022-03-26 15:34:00 +0900
committerGitHub <noreply@github.com>2022-03-26 15:34:00 +0900
commit1c67c26bd87aae64fe0f2ef45140e12a78564699 (patch)
tree633a3fad1c5841ea20bc39d6b681b455bbdeabf3 /CONTRIBUTING.md
parent.js (diff)
downloadmisskey-1c67c26bd87aae64fe0f2ef45140e12a78564699.tar.gz
misskey-1c67c26bd87aae64fe0f2ef45140e12a78564699.tar.bz2
misskey-1c67c26bd87aae64fe0f2ef45140e12a78564699.zip
refactor: migrate to typeorm 3.0 (#8443)
* wip * wip * wip * Update following.ts * wip * wip * wip * Update resolve-user.ts * maxQueryExecutionTime * wip * wip
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6e0f500be5..e38de39691 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -198,11 +198,13 @@ MongoDBの時とは違い、findOneでレコードを取得する時に対象レ
MongoDBは`null`で返してきてたので、その感覚で`if (x === null)`とか書くとバグる。代わりに`if (x == null)`と書いてください
### Migration作成方法
-```
-npx ts-node ./node_modules/typeorm/cli.js migration:generate -n 変更の名前 -o
+packages/backendで:
+```sh
+npx typeorm migration:generate -d ormconfig.js -o <migration name>
```
-作成されたスクリプトは不必要な変更を含むため除去してください。
+- 生成後、ファイルをmigration下に移してください
+- 作成されたスクリプトは不必要な変更を含むため除去してください
### コネクションには`markRaw`せよ
**Vueのコンポーネントのdataオプションとして**misskey.jsのコネクションを設定するとき、必ず`markRaw`でラップしてください。インスタンスが不必要にリアクティブ化されることで、misskey.js内の処理で不具合が発生するとともに、パフォーマンス上の問題にも繋がる。なお、Composition APIを使う場合はこの限りではない(リアクティブ化はマニュアルなため)。