Merge pull request #2565 from syuilo/contribution-guide

Update contribution guide

CONTRIBUTING.md

@@ -1,27 +1,27 @@
 # Contribution guide
-:v: Misskeyへの貢献ありがとうございます。 :v:
+:v: Thanks for your contributions :v:
 
-## Issueの報告
+## Issues
-新機能の提案や不具合の報告は https://github.com/syuilo/misskey/issues で管理しています。
+Feature suggestions and bug reports are filed in https://github.com/syuilo/misskey/issues .
-Issueを作成する前に、既に同じIssueが作成されていないかご確認ください。
+Before creating a new issue, please search existing issues to avoid duplication.
-もし既にIssueが作成されている場合は、既存のIssueにコメントをしたりリアクションをするようお願いします。
+If you find the existing issue, please add your reaction or comment to the issue.
 
-## Issueの解決
+## Internationalization (i18n)
-[pr-welcomeのラベルがついているIssue](https://github.com/syuilo/misskey/labels/pr-welcome)
+Please see [Translation guide](./docs/translate.en.md).
-の解決を目的としたPull Requestを作成してくださると非常にありがたいです。
 
-## 翻訳の改善
+## Localization (l10n)
-ソースコード中の `%i18n:id%` という形の文字列は、言語ファイルの対応するテキストに置換されます。
+Please use Crowdin for localization.
-言語ファイルは /locales ディレクトリに存在します。
 
-## ドキュメントの編集
+[![Crowdin](https://d322cqt584bo4o.cloudfront.net/misskey/localized.svg)](https://crowdin.com/project/misskey)
-現在Misskeyはドキュメントが大きく不足しています。
-ドキュメントは /docs ディレクトリに存在します。
 
-## テストの追加
+## Documentation
-現在Misskeyはテストが大きく不足しています。
+* Documents for contributors are located in `/docs`.
-テストコードは /test ディレクトリに存在します。
+* Documents for instance admins are located in `/docs`.
+* Documents for end users are located in `src/docs`.
 
-## 自動テスト及び自動リリース
+## Test
-Travis CIで行っています。
+* Test codes are located in `/test`.
-設定ファイルは /.travis に存在します。
+
+## Continuous integration
+Misskey uses Travis for automated test.
+Configuration files are located in `/.travis`.

README.md

@@ -32,22 +32,11 @@ and more! You can see it with your own eyes at [misskey.xyz](https://misskey.xyz
 
 :package: Create your own instance
 ----------------------------------------------------------------
-If you want to run your own instance of Misskey,
+Please see [Setup and installation guide](./docs/setup.en.md).
-please see [Setup and installation guide](./docs/setup.en.md).
 
-:wrench: Contribute
+:wrench: Contribution
 ----------------------------------------------------------------
-**[PR](https://github.com/syuilo/misskey/pulls)s welcome!**
+Please see [Contribution guide](./CONTRIBUTING.md).
-
-### i18n
-
-Please see [Translation guide](./docs/translate.en.md).
-
-### l10n
-
-Misskey is using Crowdin for l10n.
-
-[![Crowdin](https://d322cqt584bo4o.cloudfront.net/misskey/localized.svg)](https://crowdin.com/project/misskey)
 
 :heart: Backers & Sponsors
 ----------------------------------------------------------------

locales/README.md

@@ -1,5 +1,3 @@
-# **Please DO NOT edit these files** except `ja-JP.yml`.
+# **DO NOT edit locale files** except `ja-JP.yml`.
 
-If you want to...
+Please see [Contribution guide](../CONTRIBUTING.md) for more information.
-* i18n ... please see [Translation guide](../docs/translate.en.md).
-* l10n ... please visit https://crowdin.com/project/misskey