Merge branch 'develop'

9 files changed, 106 insertions, 32 deletions

diff --git a/docs/CONTRIBUTING.en.md b/docs/CONTRIBUTING.en.md
new file mode 100644
index 0000000000..21f2b591f3
--- /dev/null
+++ b/docs/CONTRIBUTING.en.md
@@ -0,0 +1,66 @@
+# Contribution guide
+:v: Thanks for your contributions :v:
+
+**ℹ️ Important:** This project uses Japanese as its major language, **but you do not need to translate and write the Issues/PRs in Japanese.**
+Also, you might receive comments on your Issue/PR in Japanese, but you do not need to reply to them in Japanese as well.\
+The accuracy of translation into Japanese is not high, so it will be easier for us to understand if you write it in the original language.
+It will also allow the reader to use the translation tool of their preference if necessary.
+
+## Issues
+Before creating an issue, please check the following:
+- To avoid duplication, please search for similar issues before creating a new issue.
+- Do not use Issues as a question.
+	- Issues should only be used to feature requests, suggestions, and report problems.
+	- Please ask questions in the [Misskey Forum](https://forum.misskey.io/) or [Discord](https://discord.gg/Wp8gVStHW3).
+
+## Before implementation
+When you want to add a feature or fix a bug, first have the design and policy reviewed in an Issue (if it is not there, please make one). Without this step, there is a high possibility that the PR will not be merged even if it is implemented.
+
+Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask another member to assign you). By expressing your intention to work the Issue, you can prevent conflicts in the work.
+
+## Well-known branches
+- **`master`** branch is tracking the latest release and used for production purposes.
+- **`develop`** branch is where we work for the next release.
+	- When you create a PR, basically target it to this branch.
+- **`l10n_develop`** branch is reserved for localization management.
+
+## Creating a PR
+Thank you for your PR! Before creating a PR, please check the following:
+- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
+  - `fix` / `refactor` / `feat` / `enhance` / `perf` / `chore` etc
+  - Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
+- If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
+- Please add the summary of the changes to [`CHANGELOG.md`](/CHANGELOG.md). However, this is not necessary for changes that do not affect the users, such as refactoring.
+- Check if there are any documents that need to be created or updated due to this change.
+- If you have added a feature or fixed a bug, please add a test case if possible.
+- Please make sure that tests and Lint are passed in advance.
+  - You can run it with `npm run test` and `npm run lint`. [See more info](#testing)
+- If this PR includes UI changes, please attach a screenshot in the text.
+
+Thanks for your cooperation 🤗
+
+## Localization (l10n)
+Misskey uses [Crowdin](https://crowdin.com/project/misskey) for localization management.
+You can improve our translations with your Crowdin account.
+Your changes in Crowdin are automatically submitted as a PR (with the title "New Crowdin translations") to the repository.
+The owner [@syuilo](https://github.com/syuilo) merges the PR into the develop branch before the next release.
+
+If your language is not listed in Crowdin, please open an issue.
+
+![Crowdin](https://d322cqt584bo4o.cloudfront.net/misskey/localized.svg)
+
+## Testing
+- Test codes are located in [`/test`](/test).
+
+### Run test
+```
+npm run test
+```
+
+#### Run specify test
+```
+npx cross-env TS_NODE_FILES=true TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT="./test/tsconfig.json" npx mocha test/foo.ts --require ts-node/register
+```
+
+### e2e tests
+TODO
diff --git a/docs/docker.en.md b/docs/docker.en.md
index 93eee8e4b4..adeafe3d31 100644
--- a/docs/docker.en.md
+++ b/docs/docker.en.md
@@ -83,10 +83,11 @@ Just `docker-compose up -d`. GLHF!
 1. `git stash`
 2. `git checkout master`
 3. `git pull`
-4. `git stash pop`
-5. `docker-compose build`
-6. Check [ChangeLog](../CHANGELOG.md) for migration information
-7. `docker-compose stop && docker-compose up -d`
+4. `git submodule update --init`
+5. `git stash pop`
+6. `docker-compose build`
+7. Check [ChangeLog](../CHANGELOG.md) for migration information
+8. `docker-compose stop && docker-compose up -d`
 
 ### How to execute [cli commands](manage.en.md):
 `docker-compose run --rm web node built/tools/mark-admin @example`
diff --git a/docs/docker.fr.md b/docs/docker.fr.md
index 7abd46335f..840e5b5a28 100644
--- a/docs/docker.fr.md
+++ b/docs/docker.fr.md
@@ -50,10 +50,11 @@ Utilisez la commande `docker-compose up -d`. GLHF!
 1. `git stash`
 2. `git checkout master`
 3. `git pull`
-4. `git stash pop`
-5. `docker-compose build`
-6. Consultez le [ChangeLog](../CHANGELOG.md) pour avoir les éventuelles informations de migration
-7. `docker-compose stop && docker-compose up -d`
+4. `git submodule update --init`
+5. `git stash pop`
+6. `docker-compose build`
+7. Consultez le [ChangeLog](../CHANGELOG.md) pour avoir les éventuelles informations de migration
+8. `docker-compose stop && docker-compose up -d`
 
 ### Comment exécuter des [commandes](manage.fr.md)
 `docker-compose run --rm web node built/tools/mark-admin @example`
diff --git a/docs/docker.ja.md b/docs/docker.ja.md
index 15b1a944ac..c660a9041b 100644
--- a/docs/docker.ja.md
+++ b/docs/docker.ja.md
@@ -83,10 +83,11 @@ docker-compose run --rm web yarn run init
 1. `git stash`
 2. `git checkout master`
 3. `git pull`
-4. `git stash pop`
-5. `docker-compose build`
-6. [ChangeLog](../CHANGELOG.md)でマイグレーション情報を確認する
-7. `docker-compose stop && docker-compose up -d`
+4. `git submodule update --init`
+5. `git stash pop`
+6. `docker-compose build`
+7. [ChangeLog](../CHANGELOG.md)でマイグレーション情報を確認する
+8. `docker-compose stop && docker-compose up -d`
 
 ### cliコマンドを実行する方法:
 
diff --git a/docs/docker.zh.md b/docs/docker.zh.md
index a842fcb0cc..5a494ea11e 100644
--- a/docs/docker.zh.md
+++ b/docs/docker.zh.md
@@ -83,10 +83,11 @@ docker-compose run --rm web yarn run init
 1. `git stash`
 2. `git checkout master`
 3. `git pull`
-4. `git stash pop`
-5. `docker-compose build`
-6. 检查 [更新日志](../CHANGELOG.md) 以获取升级迁移信息。
-7. `docker-compose stop && docker-compose up -d`
+4. `git submodule update --init`
+5. `git stash pop`
+6. `docker-compose build`
+7. 检查 [更新日志](../CHANGELOG.md) 以获取升级迁移信息。
+8. `docker-compose stop && docker-compose up -d`
 
 ### 如何执行 [控制台指令](manage.zh.md):
 `docker-compose run --rm web node built/tools/mark-admin @example`
diff --git a/docs/setup.en.md b/docs/setup.en.md
index bb72fcda1e..dfe50a6600 100644
--- a/docs/setup.en.md
+++ b/docs/setup.en.md
@@ -131,11 +131,12 @@ You can check if the service is running with `systemctl status misskey`.
 ### How to update your Misskey server to the latest version
 1. `git checkout master`
 2. `git pull`
-3. `yarn install`
-4. `NODE_ENV=production yarn build`
-5. `yarn migrate`
-6. Restart your Misskey process to apply changes
-7. Enjoy
+3. `git submodule update --init`
+4. `yarn install`
+5. `NODE_ENV=production yarn build`
+6. `yarn migrate`
+7. Restart your Misskey process to apply changes
+8. Enjoy
 
 If you encounter any problems with updating, please try the following:
 1. `yarn clean` or `yarn cleanall`
diff --git a/docs/setup.fr.md b/docs/setup.fr.md
index 7f4795eec5..f38c7a8eab 100644
--- a/docs/setup.fr.md
+++ b/docs/setup.fr.md
@@ -126,9 +126,10 @@ Vous pouvez vérifier si le service a démarré en utilisant la commande `system
 ### Méthode de mise à jour vers la plus récente version de Misskey
 1. `git checkout master`
 2. `git pull`
-3. `yarn install`
-4. `NODE_ENV=production yarn build`
-5. `yarn migrate`
+3. `git submodule update --init`
+4. `yarn install`
+5. `NODE_ENV=production yarn build`
+6. `yarn migrate`
 
 ----------------------------------------------------------------
 
diff --git a/docs/setup.ja.md b/docs/setup.ja.md
index e8bae56f43..5681ee8c51 100644
--- a/docs/setup.ja.md
+++ b/docs/setup.ja.md
@@ -133,9 +133,10 @@ yarn run init
 ### Misskeyを最新バージョンにアップデートする方法:
 1. `git checkout master`
 2. `git pull`
-3. `yarn install`
-4. `NODE_ENV=production yarn build`
-5. `yarn migrate`
+3. `git submodule update --init`
+4. `yarn install`
+5. `NODE_ENV=production yarn build`
+6. `yarn migrate`
 
 なにか問題が発生した場合は、`yarn clean`または`yarn cleanall`すると直る場合があります。
 
diff --git a/docs/setup.zh.md b/docs/setup.zh.md
index 50664706b7..26a72f0d05 100644
--- a/docs/setup.zh.md
+++ b/docs/setup.zh.md
@@ -131,11 +131,12 @@ yarn run init
 ### 如何将您的 Misskey 服务器升级至最新版本
 1. `git checkout master`
 2. `git pull`
-3. `yarn install`
-4. `NODE_ENV=production yarn build`
-5. `yarn migrate`
-6. 重启您的 Misskey 进程来应用改变。
-7. 尽情享受吧！
+3. `git submodule update --init`
+4. `yarn install`
+5. `NODE_ENV=production yarn build`
+6. `yarn migrate`
+7. 重启您的 Misskey 进程来应用改变。
+8. 尽情享受吧！
 
 如果您在更新时遇到任何问题，请尝试以下操作：
 1. `yarn clean` 或是 `yarn cleanall`