From 90635d530c10b708a2eeba222237597449320d80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rok=20=C4=8Cerni=C4=8D?= Date: Fri, 24 May 2024 14:15:10 +0200 Subject: [PATCH 1/3] chore: add pr template --- .github/pull_request_template.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..229eb61c1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ +# Description + +Write an explicit description about what the commit changes, and how you +implemented the change. The quality of the descriptions directly impacts the +quality of the review and because of this - PR’s without proper description will +be declined. Add some additional resources that could help the reviewer with the +review. Like link to specs if implementing a protocol. + +Checklist: +[] - Checked that the CI is successful From 21471a63ff7a500f96b74db0fa6dacb86ffa44bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rok=20=C4=8Cerni=C4=8D?= Date: Fri, 24 May 2024 14:22:05 +0200 Subject: [PATCH 2/3] chore: changed the format and content --- .github/pull_request_template.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 229eb61c1..d893a4305 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,19 @@ -# Description +### Description Write an explicit description about what the commit changes, and how you implemented the change. The quality of the descriptions directly impacts the quality of the review and because of this - PR’s without proper description will -be declined. Add some additional resources that could help the reviewer with the +be declined. + +### 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: -[] - Checked that the CI is successful +### Checklist + +— [ ] Make sure that you described overall what does this change do. +— [ ] What are the important points that reviewers should now? +— [ ] If there are follow-ups, have you created issues for them? +— [ ] Have you tested this solution? +— [ ] Were there any alternative implementations considered? From fbc3fe460bde09daa6ec2c326142c7556baa6dcf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rok=20=C4=8Cerni=C4=8D?= Date: Mon, 27 May 2024 08:44:00 +0200 Subject: [PATCH 3/3] fix: sugested changes from pr --- .github/pull_request_template.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d893a4305..05405f445 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,13 @@ ### Description -Write an explicit description about what the commit changes, and how you -implemented the change. The quality of the descriptions directly impacts the -quality of the review and because of this - PR’s without proper description will -be declined. +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 @@ -12,8 +16,11 @@ review. Like link to specs if implementing a protocol. ### Checklist -— [ ] Make sure that you described overall what does this change do. -— [ ] What are the important points that reviewers should now? -— [ ] If there are follow-ups, have you created issues for them? -— [ ] Have you tested this solution? -— [ ] Were there any alternative implementations considered? +- [ ] 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?