diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ba46dfdc72..3c7f9e21d7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,29 @@ <!-- ℹ お読みください PRありがとうございます! PRを作成する前に、以下をご確認ください: -可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。 -fix / refactor / feat / enhance / perf / chore -また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。 -このPRによって解決されるIssueがある場合は、そのIssue IDを本文内に記入してください。 -CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。 -機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。 +- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。 + - fix / refactor / feat / enhance / perf / chore + - また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。 +- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。 +- CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。 +- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。 +- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。 +- テスト、Lintが通っていることを予め確認してください。 + - `npm run test`、`npm run lint`でぞれぞれ実施可能です +- UIに変更がある場合はスクリーンショットを本文内に添付してください。 ご協力ありがとうございます🤗 --> <!-- ℹ README 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 -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 to be resolved by this PR, please include the Issue ID 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. -If you have added a feature or fixed a bug, please add a test case if possible. +- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below. + - 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`. +- If this PR includes UI changes, please attach a screenshot in the text. Thanks for your cooperation 🤗 --> @@ -29,4 +37,3 @@ Thanks for your cooperation 🤗 # Additional info (optional) <!-- テスト観点など --> -<!-- Test perspective, etc -->