From d9d172fb5bfd4e71a7d43d9a4da8e3fd31e12c4a Mon Sep 17 00:00:00 2001 From: Olga Naumenko <64418523+olganaumenko@users.noreply.github.com> Date: Wed, 25 Jan 2023 11:31:34 +0300 Subject: [PATCH 1/2] Add minor hints to PR template --- .github/pull_request_template.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 58d1eb9a06..74ecf5a2b6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -25,7 +25,9 @@ Check that the title contains ## Description -- Mention the related issue (_**"Fixes #..."**_) or describe why you've made the changes. +Fixes # (issue) + +- If there is no related issue, describe why you've made the changes. - Add useful info for your reviewer or another contributor. ## How to test @@ -46,11 +48,13 @@ If this is your case, share the detailed _manual scenarios_ that help to verify ## Self-check list -Check off the item if the statement is true: +Check off the item if the statement is true. Hint: [x] is a marked item. + +Please do not delete the list or its items. - [ ] I've set the proper **labels** for my PR (at least, for category and component). - [ ] PR **title** and **description** are clear and intelligible. -- [ ] I've added enough **comments**, particularly in hard-to-understand areas. +- [ ] I've added enough **comments** to my code, particularly in hard-to-understand areas. - [ ] The functionality I've repaired, changed or added is covered with **automated tests**. - [ ] **Manual tests** have been provided optionally. - [ ] The **documentation** for the functionality I've been working on is up-to-date. \ No newline at end of file From 53b694334bbee9d447a032cddc5aa0722eaa9d8e Mon Sep 17 00:00:00 2001 From: Olga Naumenko <64418523+olganaumenko@users.noreply.github.com> Date: Wed, 25 Jan 2023 12:29:32 +0300 Subject: [PATCH 2/2] Change wording for Description --- .github/pull_request_template.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 74ecf5a2b6..afc8194fb8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,8 +27,9 @@ Check that the title contains Fixes # (issue) -- If there is no related issue, describe why you've made the changes. -- Add useful info for your reviewer or another contributor. +Add more info _if needed_: +* context/purpose for implementing changes +* detailed description of the changes made ## How to test