From 7943fa18ab75120b6d39ab38dc21bc52b30ca000 Mon Sep 17 00:00:00 2001 From: Valentina Kats Date: Tue, 25 Jun 2024 21:18:18 +0200 Subject: [PATCH 1/8] Update issue templates --- .github/ISSUE_TEMPLATE/ask-a-question.md | 10 +++++++ .../bug-or-performance-issue-report.md | 26 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/ask-a-question.md create mode 100644 .github/ISSUE_TEMPLATE/bug-or-performance-issue-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md new file mode 100644 index 00000000000..faf09440917 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -0,0 +1,10 @@ +--- +name: Ask a question +about: Use this template for everything that is not a bug or feature request +title: '' +labels: help wanted, question +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/bug-or-performance-issue-report.md b/.github/ISSUE_TEMPLATE/bug-or-performance-issue-report.md new file mode 100644 index 00000000000..57468bbb49e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-or-performance-issue-report.md @@ -0,0 +1,26 @@ +--- +name: Bug or performance issue report +about: Create a report to help us improve oneDPL +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug or performance issue is. + +**To Reproduce** +Steps to reproduce the behavior: + +The following information might be useful: + - CMake command: [e.g.cmake -DCMAKE_CXX_COMPILER=icpx -DCMAKE_BUILD_TYPE=release -DONEDPL_PAR_BACKEND=tbb] +- oneDPL version: [e.g. 2022.6.0 or 224acf7423ded15d34b53429d99248c3d308b685] +Report oneDPL version and githash. If it is a regression, report githash for the last known good revision. + - Compiler: [e.g. Intel(R) oneAPI DPC++/C++ Compiler 2023.1.0 (2023.1.0.20230320)] + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..a154ae87e47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for oneDPL +title: '' +labels: feature_request +assignees: '' + +--- + +**Summary** +A clear and concise description of the request. + +**Problem statement** +Describe the problem you are trying to solve. + +**Preferred solution** +Document your thoughts on what solution may look like. + +**Additional context** +Add any other context about the feature request here. From d86fb694448ead30f56004f1d129df80f468b0ec Mon Sep 17 00:00:00 2001 From: Valentina Kats Date: Wed, 26 Jun 2024 16:35:50 +0200 Subject: [PATCH 2/8] Add new doc template, introduce order for names --- ...{ask-a-question.md => 1_ask-a-question.md} | 0 ...d => 2_bug-or-performance-issue-report.md} | 0 ...eature_request.md => 3_feature_request.md} | 0 .../ISSUE_TEMPLATE/4_documentation_change.md | 21 +++++++++++++++++++ 4 files changed, 21 insertions(+) rename .github/ISSUE_TEMPLATE/{ask-a-question.md => 1_ask-a-question.md} (100%) rename .github/ISSUE_TEMPLATE/{bug-or-performance-issue-report.md => 2_bug-or-performance-issue-report.md} (100%) rename .github/ISSUE_TEMPLATE/{feature_request.md => 3_feature_request.md} (100%) create mode 100644 .github/ISSUE_TEMPLATE/4_documentation_change.md diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/1_ask-a-question.md similarity index 100% rename from .github/ISSUE_TEMPLATE/ask-a-question.md rename to .github/ISSUE_TEMPLATE/1_ask-a-question.md diff --git a/.github/ISSUE_TEMPLATE/bug-or-performance-issue-report.md b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md similarity index 100% rename from .github/ISSUE_TEMPLATE/bug-or-performance-issue-report.md rename to .github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/3_feature_request.md similarity index 100% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/3_feature_request.md diff --git a/.github/ISSUE_TEMPLATE/4_documentation_change.md b/.github/ISSUE_TEMPLATE/4_documentation_change.md new file mode 100644 index 00000000000..cdc38c459aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_documentation_change.md @@ -0,0 +1,21 @@ +--- +name: Documentation change request +about: Report documentation issue or request documentation changes +title: '' +labels: documentation +assignees: '' + +--- + +**Summary** +Include a short summary of the issue or request. +See the sections below +for factors important for a documentation +issue. + +**URLs** +Include pointers to pages that are impacted. + +**Additional details** +Provide a detailed description of the expected changes in documentation +and suggestions you have. From 94f0ea3fefb4bc2342c61c34c2b60c829a1d4a52 Mon Sep 17 00:00:00 2001 From: Valentina Kats Date: Thu, 27 Jun 2024 18:17:32 +0200 Subject: [PATCH 3/8] Update 2_bug-or-performance-issue-report.md --- .../ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md index 57468bbb49e..0beae7b50b6 100644 --- a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md +++ b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md @@ -15,9 +15,11 @@ Steps to reproduce the behavior: The following information might be useful: - CMake command: [e.g.cmake -DCMAKE_CXX_COMPILER=icpx -DCMAKE_BUILD_TYPE=release -DONEDPL_PAR_BACKEND=tbb] -- oneDPL version: [e.g. 2022.6.0 or 224acf7423ded15d34b53429d99248c3d308b685] -Report oneDPL version and githash. If it is a regression, report githash for the last known good revision. - - Compiler: [e.g. Intel(R) oneAPI DPC++/C++ Compiler 2023.1.0 (2023.1.0.20230320)] + - oneDPL version: [e.g. 2022.6.0 or 224acf7423ded15d34b53429d99248c3d308b685]
+ Report oneDPL version and githash. If it is a regression, report githash for the last known good revision. + - Compiler version: [e.g. Intel(R) oneAPI DPC++/C++ Compiler 2023.1.0 (2023.1.0.20230320)] + - OS: [e.g. Ubuntu 22.04] + - Device and driver version: [e.g. Intel(R) Iris(R) Xe Graphics, 1.3.29138] **Expected behavior** A clear and concise description of what you expected to happen. From c4a352c751e5c4fe31c26f6ad631f067915cb6a8 Mon Sep 17 00:00:00 2001 From: Valentina Kats Date: Thu, 27 Jun 2024 18:19:05 +0200 Subject: [PATCH 4/8] Update 3_feature_request.md --- .github/ISSUE_TEMPLATE/3_feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3_feature_request.md b/.github/ISSUE_TEMPLATE/3_feature_request.md index a154ae87e47..373c9a4839b 100644 --- a/.github/ISSUE_TEMPLATE/3_feature_request.md +++ b/.github/ISSUE_TEMPLATE/3_feature_request.md @@ -14,7 +14,7 @@ A clear and concise description of the request. Describe the problem you are trying to solve. **Preferred solution** -Document your thoughts on what solution may look like. +If you have thoughts on what a solution may look like, please document them here. **Additional context** Add any other context about the feature request here. From 369036d0a38d35f8b55ee96066d59e85d990c2d6 Mon Sep 17 00:00:00 2001 From: timmiesmith Date: Wed, 3 Jul 2024 17:34:07 -0500 Subject: [PATCH 5/8] Correcting capitalization of table columns. --- .github/ISSUE_TEMPLATE/1_ask-a-question.md | 10 +++++----- .../2_bug-or-performance-issue-report.md | 10 +++++----- .github/ISSUE_TEMPLATE/3_feature_request.md | 10 +++++----- .github/ISSUE_TEMPLATE/4_documentation_change.md | 10 +++++----- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_ask-a-question.md b/.github/ISSUE_TEMPLATE/1_ask-a-question.md index faf09440917..13bc4ef37a5 100644 --- a/.github/ISSUE_TEMPLATE/1_ask-a-question.md +++ b/.github/ISSUE_TEMPLATE/1_ask-a-question.md @@ -1,9 +1,9 @@ --- -name: Ask a question -about: Use this template for everything that is not a bug or feature request -title: '' -labels: help wanted, question -assignees: '' +Name: Ask a question +About: Use this template for everything that is not a bug or feature request +Title: '' +Labels: help wanted, question +Assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md index 0beae7b50b6..1c22176c11a 100644 --- a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md +++ b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md @@ -1,9 +1,9 @@ --- -name: Bug or performance issue report -about: Create a report to help us improve oneDPL -title: '' -labels: bug -assignees: '' +Name: Bug or performance issue report +About: Create a report to help us improve oneDPL +Title: '' +Labels: bug +Assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/3_feature_request.md b/.github/ISSUE_TEMPLATE/3_feature_request.md index 373c9a4839b..6ae07730199 100644 --- a/.github/ISSUE_TEMPLATE/3_feature_request.md +++ b/.github/ISSUE_TEMPLATE/3_feature_request.md @@ -1,9 +1,9 @@ --- -name: Feature request -about: Suggest an idea for oneDPL -title: '' -labels: feature_request -assignees: '' +Name: Feature request +About: Suggest an idea for oneDPL +Title: '' +Labels: feature_request +Assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/4_documentation_change.md b/.github/ISSUE_TEMPLATE/4_documentation_change.md index cdc38c459aa..19bce3fc0ab 100644 --- a/.github/ISSUE_TEMPLATE/4_documentation_change.md +++ b/.github/ISSUE_TEMPLATE/4_documentation_change.md @@ -1,9 +1,9 @@ --- -name: Documentation change request -about: Report documentation issue or request documentation changes -title: '' -labels: documentation -assignees: '' +Name: Documentation change request +About: Report documentation issue or request documentation changes +Title: '' +Labels: documentation +Assignees: '' --- From 5fab8778b3a01d5933e96919b7c05679769b9e61 Mon Sep 17 00:00:00 2001 From: timmiesmith Date: Wed, 3 Jul 2024 17:40:03 -0500 Subject: [PATCH 6/8] Making capitalization consistent. Adding colons on section headers. --- .github/ISSUE_TEMPLATE/1_ask-a-question.md | 2 +- .../2_bug-or-performance-issue-report.md | 10 +++++----- .github/ISSUE_TEMPLATE/3_feature_request.md | 10 +++++----- .github/ISSUE_TEMPLATE/4_documentation_change.md | 8 ++++---- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_ask-a-question.md b/.github/ISSUE_TEMPLATE/1_ask-a-question.md index 13bc4ef37a5..29f6e56c433 100644 --- a/.github/ISSUE_TEMPLATE/1_ask-a-question.md +++ b/.github/ISSUE_TEMPLATE/1_ask-a-question.md @@ -1,6 +1,6 @@ --- Name: Ask a question -About: Use this template for everything that is not a bug or feature request +About: Use this template for everything that is not a bug or feature request. Title: '' Labels: help wanted, question Assignees: '' diff --git a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md index 1c22176c11a..62cb17a156a 100644 --- a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md +++ b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md @@ -1,16 +1,16 @@ --- Name: Bug or performance issue report -About: Create a report to help us improve oneDPL +About: Create a report to help us improve oneDPL. Title: '' Labels: bug Assignees: '' --- -**Describe the bug** +**Describe the Bug:** A clear and concise description of what the bug or performance issue is. -**To Reproduce** +**To Reproduce:** Steps to reproduce the behavior: The following information might be useful: @@ -21,8 +21,8 @@ The following information might be useful: - OS: [e.g. Ubuntu 22.04] - Device and driver version: [e.g. Intel(R) Iris(R) Xe Graphics, 1.3.29138] -**Expected behavior** +**Expected Behavior:** A clear and concise description of what you expected to happen. -**Additional context** +**Additional Context:** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/3_feature_request.md b/.github/ISSUE_TEMPLATE/3_feature_request.md index 6ae07730199..4d5ecfacdb6 100644 --- a/.github/ISSUE_TEMPLATE/3_feature_request.md +++ b/.github/ISSUE_TEMPLATE/3_feature_request.md @@ -1,20 +1,20 @@ --- Name: Feature request -About: Suggest an idea for oneDPL +About: Suggest an idea for oneDPL. Title: '' Labels: feature_request Assignees: '' --- -**Summary** +**Summary:** A clear and concise description of the request. -**Problem statement** +**Problem Statement:** Describe the problem you are trying to solve. -**Preferred solution** +**Preferred Solution:** If you have thoughts on what a solution may look like, please document them here. -**Additional context** +**Additional Context:** Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/4_documentation_change.md b/.github/ISSUE_TEMPLATE/4_documentation_change.md index 19bce3fc0ab..c5c38de603b 100644 --- a/.github/ISSUE_TEMPLATE/4_documentation_change.md +++ b/.github/ISSUE_TEMPLATE/4_documentation_change.md @@ -1,21 +1,21 @@ --- Name: Documentation change request -About: Report documentation issue or request documentation changes +About: Report documentation issue or request documentation changes. Title: '' Labels: documentation Assignees: '' --- -**Summary** +**Summary:** Include a short summary of the issue or request. See the sections below for factors important for a documentation issue. -**URLs** +**URLs:** Include pointers to pages that are impacted. -**Additional details** +**Additional Details:** Provide a detailed description of the expected changes in documentation and suggestions you have. From cd46d599bc38654a7da71657c8323d92ffcea62d Mon Sep 17 00:00:00 2001 From: timmiesmith Date: Wed, 3 Jul 2024 17:42:45 -0500 Subject: [PATCH 7/8] Replacing e.g. usage. --- .../2_bug-or-performance-issue-report.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md index 62cb17a156a..81a4ebead0e 100644 --- a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md +++ b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md @@ -14,12 +14,12 @@ A clear and concise description of what the bug or performance issue is. Steps to reproduce the behavior: The following information might be useful: - - CMake command: [e.g.cmake -DCMAKE_CXX_COMPILER=icpx -DCMAKE_BUILD_TYPE=release -DONEDPL_PAR_BACKEND=tbb] - - oneDPL version: [e.g. 2022.6.0 or 224acf7423ded15d34b53429d99248c3d308b685]
+ - CMake command: [for example, cmake -DCMAKE_CXX_COMPILER=icpx -DCMAKE_BUILD_TYPE=release -DONEDPL_PAR_BACKEND=tbb] + - oneDPL version: [for example, 2022.6.0 or 224acf7423ded15d34b53429d99248c3d308b685]
Report oneDPL version and githash. If it is a regression, report githash for the last known good revision. - - Compiler version: [e.g. Intel(R) oneAPI DPC++/C++ Compiler 2023.1.0 (2023.1.0.20230320)] - - OS: [e.g. Ubuntu 22.04] - - Device and driver version: [e.g. Intel(R) Iris(R) Xe Graphics, 1.3.29138] + - Compiler version: [for example, Intel(R) oneAPI DPC++/C++ Compiler 2023.1.0 (2023.1.0.20230320)] + - OS: [for example, Ubuntu 22.04] + - Device and driver version: [for example, Intel(R) Iris(R) Xe Graphics, 1.3.29138] **Expected Behavior:** A clear and concise description of what you expected to happen. From d860f9aa5822dc6adfedebb79383c9a98d307cb8 Mon Sep 17 00:00:00 2001 From: timmiesmith Date: Wed, 3 Jul 2024 17:49:15 -0500 Subject: [PATCH 8/8] Revise wording as suggested in review. --- .../ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md | 4 ++-- .github/ISSUE_TEMPLATE/4_documentation_change.md | 7 ++----- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md index 81a4ebead0e..1160993d014 100644 --- a/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md +++ b/.github/ISSUE_TEMPLATE/2_bug-or-performance-issue-report.md @@ -11,12 +11,12 @@ Assignees: '' A clear and concise description of what the bug or performance issue is. **To Reproduce:** -Steps to reproduce the behavior: +The steps to reproduce the behavior: The following information might be useful: - CMake command: [for example, cmake -DCMAKE_CXX_COMPILER=icpx -DCMAKE_BUILD_TYPE=release -DONEDPL_PAR_BACKEND=tbb] - oneDPL version: [for example, 2022.6.0 or 224acf7423ded15d34b53429d99248c3d308b685]
- Report oneDPL version and githash. If it is a regression, report githash for the last known good revision. + Report oneDPL version and git hash. If it is a regression, report git hash for the last known good revision. - Compiler version: [for example, Intel(R) oneAPI DPC++/C++ Compiler 2023.1.0 (2023.1.0.20230320)] - OS: [for example, Ubuntu 22.04] - Device and driver version: [for example, Intel(R) Iris(R) Xe Graphics, 1.3.29138] diff --git a/.github/ISSUE_TEMPLATE/4_documentation_change.md b/.github/ISSUE_TEMPLATE/4_documentation_change.md index c5c38de603b..8863e85eced 100644 --- a/.github/ISSUE_TEMPLATE/4_documentation_change.md +++ b/.github/ISSUE_TEMPLATE/4_documentation_change.md @@ -9,13 +9,10 @@ Assignees: '' **Summary:** Include a short summary of the issue or request. -See the sections below -for factors important for a documentation -issue. **URLs:** Include pointers to pages that are impacted. **Additional Details:** -Provide a detailed description of the expected changes in documentation -and suggestions you have. +Provide a detailed description of the expected changes in the documentation +and any suggestions you have.