update contribution guide

1 files changed, 19 insertions, 1 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2042f21f29..2c0b1da684 100644
--- a/CONTRIBUTING.md
+++ b/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の作成)をご一読ください。
 また、後述の「レビュー観点」も意識してみてください。
 
 ## レビュワーの心得