diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..05405f445 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +### Description + +Write an explicit description about what the PR changes, and how you implemented +the change. + +The quality of the description directly impacts the quality of the review +process for everyone. Adding relevant context (i.e. describing the reasons for +the change, adding links to relevant documents, etc) to your description ensures +that everyone is able to easily gather the context necessary to review your +change. + +### Important points for reviewers + +Add some additional resources that could help the reviewer with the +review. Like link to specs if implementing a protocol. + +### Checklist + +- [ ] Are there important points that reviewers should know? + - [ ] If yes, which ones? +- [ ] Make sure that you described what this change does. +- [ ] If there are follow-ups, have you created issues for them? + - [ ] If yes, which ones? / List them here +- [ ] Have you tested this solution? +- [ ] Were there any alternative implementations considered? +- [ ] Did you document new (or modified) APIs?