summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2021-08-20 21:34:56 +0900
committersyuilo <Syuilotan@yahoo.co.jp>2021-08-20 21:34:56 +0900
commit3cb5ed167af31782acecbc2ccbc2e7a89ba6d633 (patch)
tree61384dcd9a09987f68aab79f4afd7322da4963a5 /CONTRIBUTING.md
parentfix: use correct query generate function (#7657) (diff)
downloadsharkey-3cb5ed167af31782acecbc2ccbc2e7a89ba6d633.tar.gz
sharkey-3cb5ed167af31782acecbc2ccbc2e7a89ba6d633.tar.bz2
sharkey-3cb5ed167af31782acecbc2ccbc2e7a89ba6d633.zip
fix: meta.jsonをimportしないように
Fix #7671
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b16d9a75d8..b3c67ff4d7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -250,6 +250,9 @@ npx ts-node ./node_modules/typeorm/cli.js migration:generate -n 変更の名前
### コネクションには`markRaw`せよ
**Vueのコンポーネントのdataオプションとして**misskey.jsのコネクションを設定するとき、必ず`markRaw`でラップしてください。インスタンスが不必要にリアクティブ化されることで、misskey.js内の処理で不具合が発生するとともに、パフォーマンス上の問題にも繋がる。なお、Composition APIを使う場合はこの限りではない(リアクティブ化はマニュアルなため)。
+### JSONのimportに気を付けよう
+TypeScriptでjsonをimportすると、tscでコンパイルするときにそのjsonファイルも一緒にdistディレクトリに吐き出されてしまう。この挙動により、意図せずファイルの書き換えが発生することがあるので、jsonをimportするときは書き換えられても良いものかどうか確認すること。書き換えされて欲しくない場合は、importで読み込むのではなく、`fs.readFileSync`などの関数を使って読み込むようにすればよい。
+
## その他
### HTMLのクラス名で follow という単語は使わない
広告ブロッカーで誤ってブロックされる