From 615f6e65d0d57a2142daaec2da0914d6aaa7e3d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Je=C5=BEek?= Date: Wed, 8 Dec 2021 12:48:29 +0100 Subject: [PATCH 1/5] removing unsupported header --- .github/PULL_REQUEST_TEMPLATE/feature-tempate.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/feature-tempate.md b/.github/PULL_REQUEST_TEMPLATE/feature-tempate.md index 0e27c7681c..6e74a073bd 100644 --- a/.github/PULL_REQUEST_TEMPLATE/feature-tempate.md +++ b/.github/PULL_REQUEST_TEMPLATE/feature-tempate.md @@ -1,12 +1,3 @@ ---- -name: Feature -about: PR for feature -title: '' -labels: "type: feature" -assignees: '' - ---- - **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] From ae8fcc8d9851b23ff88716d8340b2991f9261326 Mon Sep 17 00:00:00 2001 From: Jakub Jezek Date: Wed, 8 Dec 2021 12:51:53 +0100 Subject: [PATCH 2/5] pr template: single template only --- .../feature-tempate.md => pull_request_template.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{PULL_REQUEST_TEMPLATE/feature-tempate.md => pull_request_template.md} (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/feature-tempate.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/feature-tempate.md rename to .github/pull_request_template.md From 3287c79e4e988be63bcaf8a3d7a32b667b0b6d30 Mon Sep 17 00:00:00 2001 From: Jakub Jezek Date: Wed, 8 Dec 2021 12:57:49 +0100 Subject: [PATCH 3/5] test of pr template header --- .github/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6e74a073bd..5f0a04cee3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,11 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' +--- + **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] From 5fb526721b7c5348274a14a7de494983738bfb4d Mon Sep 17 00:00:00 2001 From: Jakub Jezek Date: Wed, 8 Dec 2021 15:30:20 +0100 Subject: [PATCH 4/5] improving PR template --- .github/pull_request_template.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5f0a04cee3..c5789d798f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,19 +1,16 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' ---- +## Brief description +First sentence is brief description. -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## Description +Next paragraf is more elaborate text with more info. This will be displayed for example in collapsed form under the first sentence in a changelog. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Additional info +The rest will be ignored in changelog and should contain any additional +technical information. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Documentation (add Documentation label) +[feature_documentation](future_url_after_it_will_be_merged) -**Additional context** -Add any other context or screenshots about the feature request here. +## Testing notes: +1. start with this step +2. follow this step \ No newline at end of file From 6e127d273cd0a598c37c9a8011200b557b81d2cd Mon Sep 17 00:00:00 2001 From: Jakub Jezek Date: Wed, 8 Dec 2021 15:33:00 +0100 Subject: [PATCH 5/5] better documentation category --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c5789d798f..20ae298f70 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,7 +8,7 @@ Next paragraf is more elaborate text with more info. This will be displayed for The rest will be ignored in changelog and should contain any additional technical information. -## Documentation (add Documentation label) +## Documentation (add _"type: documentation"_ label) [feature_documentation](future_url_after_it_will_be_merged) ## Testing notes: