summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2019-02-08 04:08:25 +0900
committerGitHub <noreply@github.com>2019-02-08 04:08:25 +0900
commit5a28632af729cf3a8dbdee91dc16bb61670acd7b (patch)
treee1003f07faccc0ba051c12954913e1fae65aa3b3 /CONTRIBUTING.md
parent[Client] Add icon :art: (diff)
downloadsharkey-5a28632af729cf3a8dbdee91dc16bb61670acd7b.tar.gz
sharkey-5a28632af729cf3a8dbdee91dc16bb61670acd7b.tar.bz2
sharkey-5a28632af729cf3a8dbdee91dc16bb61670acd7b.zip
Update CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 473e92b505..b34f16cf9f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -56,3 +56,18 @@ Good:
``` ts
export function something(foo: string): string {
```
+
+## Directory structure
+```
+src ... ソースコード
+ prelude ... Misskeyに関係ないかつ副作用なし
+ misc ... 副作用なしのユーティリティ処理
+ service ... 副作用ありの共通処理
+ queue ... ジョブキューとジョブ
+ server ... Webサーバー
+ client ... クライアント
+ mfm ... MFM
+
+test ... テスト
+
+```