update contribution guide

.github/pull_request_template.md

@@ -1,30 +1,10 @@
 <!-- ℹ お読みください
-PRありがとうございます！ PRを作成する前に、以下をご確認ください:
+PRありがとうございます！ PRを作成する前に、コントリビューションガイドをご確認ください:
-- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
+https://github.com/misskey-dev/misskey.js/blob/develop/CONTRIBUTING.md
-  - fix / refactor / feat / enhance / perf / chore
-  - また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
-- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
-- CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
-- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
-- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
-- テスト、Lintが通っていることを予め確認してください。
-  - `npm run test`、`npm run lint`でぞれぞれ実施可能です
-- `npm run api`を実行してAPIレポートを更新し、差分がある場合はコミットしてください。
-ご協力ありがとうございます🤗
 -->
 <!-- ℹ README
-Thank you for your PR! Before creating a PR, please check the following:
+Thank you for your PR! Before creating a PR, please check the contribution guide:
-- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
+https://github.com/misskey-dev/misskey.js/blob/develop/docs/CONTRIBUTING.en.md
-  - fix / refactor / feat / enhance / perf / chore
-  - 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. 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`.
-- Run `npm run api` to update the API report and commit it if there are any diffs.
-Thanks for your cooperation 🤗
 -->
 
 # What

CONTRIBUTING.md

@@ -1,4 +1,6 @@
 # Contribution guide
+**[✨ English version available](./docs/CONTRIBUTING.en.md)**
+
 プロジェクトに興味を持っていただきありがとうございます！
 このドキュメントでは、プロジェクトに貢献する際に必要な情報をまとめています。
 
@@ -8,6 +10,22 @@
 また、実装に取り掛かるときは当該Issueに自分をアサインしてください(自分でできない場合は他メンバーに自分をアサインしてもらうようお願いしてください)。
 自分が実装するという意思表示をすることで、作業がバッティングするのを防ぎます。
 
+## PRの作成
+PRを作成する前に、以下をご確認ください:
+- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
+  - fix / refactor / feat / enhance / perf / chore 等
+  - また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
+- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
+- [`CHANGELOG.md`](./CHANGELOG.md)に変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
+- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
+- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
+- テスト、Lintが通っていることを予め確認してください。
+  - `npm run test`、`npm run lint`でぞれぞれ実施可能です
+- `npm run api`を実行してAPIレポートを更新し、差分がある場合はコミットしてください。
+  - APIレポートの詳細については[こちら](#api-extractor)
+
+ご協力ありがとうございます🤗
+
 ## Tools
 ### eslint
 このプロジェクトではコードのフォーマットチェック/整形に[eslint](https://eslint.org/)を導入しています。
@@ -46,7 +64,7 @@ PRを作る際は、`npm run api`コマンドを実行してAPIレポートを
 また、各PRに対してもそのブランチのカバレッジが自動的に計算され、マージ先のカバレッジとの差分を含んだレポートがCodecovのbotによりコメントされます。これにより、そのPRをマージすることでどれくらいカバレッジが増加するのか/減少するのかを確認することができます。
 
 ## レビュイーの心得
-PRを作成するときのテンプレートに色々書いてあるので読んでみてください。(このドキュメントに移してもいいかも？)
+[PRのセクション](#PRの作成)をご一読ください。
 また、後述の「レビュー観点」も意識してみてください。
 
 ## レビュワーの心得

docs/CONTRIBUTING.en.md

@@ -0,0 +1,19 @@
+# Contribution guide
+
+## 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. 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`.
+- Run `npm run api` to update the API report and commit it if there are any diffs.
+Thanks for your cooperation 🤗
+
+**ℹ️ Important:** If your language is not Japanese, you do not need to translate and write the description in Japanese.
+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.