sharkey/.github/pull_request_template.md

41 lines
2.8 KiB
Markdown
Raw Normal View History

2021-07-27 00:01:26 +09:00
<!-- お読みください
PRありがとうございます PRを作成する前に、以下をご確認ください:
2021-07-30 01:17:57 +09:00
- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
- fix / refactor / feat / enhance / perf / chore
- また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
- CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
2021-07-30 13:01:52 +09:00
- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
2021-07-30 01:17:57 +09:00
- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
- テスト、Lintが通っていることを予め確認してください。
- `npm run test`、`npm run lint`でぞれぞれ実施可能です
2021-07-30 13:01:52 +09:00
- `npm run api`を実行してAPIレポートを更新し、差分がある場合はコミットしてください。
2021-07-27 00:01:26 +09:00
ご協力ありがとうございます🤗
-->
<!-- README
Thank you for your PR! Before creating a PR, please check the following:
2021-07-30 01:17:57 +09:00
- 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.
2021-07-30 13:01:52 +09:00
- Check if there are any documents that need to be created or updated due to this change.
2021-07-30 01:17:57 +09:00
- 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`.
2021-07-30 13:01:52 +09:00
- Run `npm run api` to update the API report and commit it if there are any diffs.
2021-07-27 00:01:26 +09:00
Thanks for your cooperation 🤗
-->
# What
<!-- このPRで何をしたのか どう変わるのか? -->
<!-- What did you do with this PR? How will it change things? -->
# Why
<!-- なぜそうするのか? どういう意図なのか? 何が困っているのか? -->
<!-- Why do you do it? What are your intentions? What is the problem? -->
# Additional info (optional)
<!-- テスト観点など -->
<!-- Test perspective, etc -->