From 16e28feafe6c580e1f19f1162d548dd57e56721d Mon Sep 17 00:00:00 2001 From: Guillaume-Helbecque Date: Thu, 10 Aug 2023 13:33:49 +0200 Subject: [PATCH 1/5] add bug, feature and perf issue templates Signed-off-by: Guillaume-Helbecque --- .../bug_report.md} | 13 +++--- .github/ISSUE_TEMPLATE/feature_request.md | 15 ++++++ .github/ISSUE_TEMPLATE/performance_issue.md | 46 +++++++++++++++++++ 3 files changed, 67 insertions(+), 7 deletions(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bug_report.md} (89%) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/performance_issue.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 89% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bug_report.md index 5cf5f2d59d41..f0e1adda1c2f 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,8 +1,9 @@ - - +--- +name: Bug Report +about: Report a bug and we will do our best to fix it. +title: '' +labels: '' +--- ### Summary of Problem - ### Steps to Reproduce **Source Code:** @@ -44,4 +44,3 @@ If an input file is required, include it as well. --> - Output of `$CHPL_HOME/util/printchplenv --anonymize`: - Back-end compiler and version, e.g. `gcc --version` or `clang --version`: - (For Cray systems only) Output of `module list`: - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000000..e3a303fec1de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,15 @@ +--- +name: Feature Request +about: Request a feature for the project. +title: '' +labels: '' +--- + +### Description of the feature + + +### Code sample diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/performance_issue.md new file mode 100644 index 000000000000..fa2ddf81eb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/performance_issue.md @@ -0,0 +1,46 @@ +--- +name: Performance Issue +about: Report any performance issue observed within your code. +title: '' +labels: '' +--- + +### Summary of Problem + + +### Steps to Reproduce + +**Source Code:** + +```chapel +// Please provide source code that will reproduce the problem. +// You can insert your code inline if it's not too long. +// Otherwise, you can attach it as a file or provide a URL to it. +// To the extent possible, providing simplified programs demonstrating the +// problem will be appreciated. +// You can also replace this section with "Associated Future Test(s)" below. +``` + +**Compile command:** + + +**Execution command:** + + +**Associated Future Test(s):** + + +### Configuration Information + +- Output of `chpl --version`: +- Output of `$CHPL_HOME/util/printchplenv --anonymize`: +- Back-end compiler and version, e.g. `gcc --version` or `clang --version`: +- (For Cray systems only) Output of `module list`: From 194dcd6b225df0f06f08e6d8f3dfb2fb3e4b2db3 Mon Sep 17 00:00:00 2001 From: Guillaume-Helbecque Date: Thu, 10 Aug 2023 13:36:03 +0200 Subject: [PATCH 2/5] Add priority level to github issue template Signed-off-by: Guillaume-Helbecque --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++++++ .github/ISSUE_TEMPLATE/performance_issue.md | 8 ++++++++ 3 files changed, 24 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f0e1adda1c2f..421dc3a20961 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,6 +12,14 @@ What behavior did you expect to observe? Is this a blocking issue with no known work-arounds? --> +**Is it a blocker for you?** + +- [ ] Yes +- [ ] No +- [ ] Will be in the future + ### Steps to Reproduce **Source Code:** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e3a303fec1de..6a0dd38e7157 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -12,4 +12,12 @@ Describe the solution you'd like. Describe alternatives you've considered --> +**Is it a blocker for you?** + +- [ ] Yes +- [ ] No +- [ ] Will be in the future + ### Code sample diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/performance_issue.md index fa2ddf81eb38..29ec3b259c41 100644 --- a/.github/ISSUE_TEMPLATE/performance_issue.md +++ b/.github/ISSUE_TEMPLATE/performance_issue.md @@ -12,6 +12,14 @@ What behavior did you expect to observe? Is this a blocking issue with no known work-arounds? --> +**Is it a blocker for you?** + +- [ ] Yes +- [ ] No +- [ ] Will be in the future + ### Steps to Reproduce **Source Code:** From 3adeec19b7fcf0f0ef6dd0b72e115c3371dde1a8 Mon Sep 17 00:00:00 2001 From: Guillaume-Helbecque Date: Wed, 20 Mar 2024 11:15:12 +0100 Subject: [PATCH 3/5] provide five issue templates and disable blank issue by default Signed-off-by: Guillaume-Helbecque --- .../{bug_report.md => 00-bug.md} | 34 ++++++------- .github/ISSUE_TEMPLATE/01-feature_request.md | 28 +++++++++++ ...performance_issue.md => 02-performance.md} | 32 +++++------- .github/ISSUE_TEMPLATE/03-documentation.md | 50 +++++++++++++++++++ .github/ISSUE_TEMPLATE/99-blank.md | 4 ++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 23 --------- 7 files changed, 113 insertions(+), 59 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.md => 00-bug.md} (64%) create mode 100644 .github/ISSUE_TEMPLATE/01-feature_request.md rename .github/ISSUE_TEMPLATE/{performance_issue.md => 02-performance.md} (60%) create mode 100644 .github/ISSUE_TEMPLATE/03-documentation.md create mode 100644 .github/ISSUE_TEMPLATE/99-blank.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/00-bug.md similarity index 64% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/00-bug.md index 421dc3a20961..c0edd72cea38 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/00-bug.md @@ -1,24 +1,20 @@ --- name: Bug Report -about: Report a bug and we will do our best to fix it. -title: '' -labels: '' +about: Report any bug observed within your code. +title: '[Bug]: ' +labels: 'type: Bug' --- ### Summary of Problem + +**Description:** -**Is it a blocker for you?** - -- [ ] Yes -- [ ] No -- [ ] Will be in the future +**Is this a blocking issue with no known work-arounds?** + ### Steps to Reproduce @@ -37,14 +33,18 @@ Tick putting 'x' inside the box. **Execution command:** - + **Associated Future Test(s):** - + ### Configuration Information diff --git a/.github/ISSUE_TEMPLATE/01-feature_request.md b/.github/ISSUE_TEMPLATE/01-feature_request.md new file mode 100644 index 000000000000..016e8dcfbd2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature Request +about: Request for any feature you'd Chapel to support. +title: '[Feature Request]: ' +labels: 'type: Feature Request' +--- + +### Summary of Feature + +**Description:** + + +**Is this a blocking issue with no known work-arounds?** + + +### Code Sample + +```chapel +// Please provide source code that you'd Chapel to support. +// You can insert your code inline if it's not too long. +// Otherwise, you can attach it as a file or provide a URL to it. +// To the extent possible, providing simplified programs demonstrating the +// problem will be appreciated. +``` diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/02-performance.md similarity index 60% rename from .github/ISSUE_TEMPLATE/performance_issue.md rename to .github/ISSUE_TEMPLATE/02-performance.md index 29ec3b259c41..74a140956260 100644 --- a/.github/ISSUE_TEMPLATE/performance_issue.md +++ b/.github/ISSUE_TEMPLATE/02-performance.md @@ -1,24 +1,20 @@ --- name: Performance Issue about: Report any performance issue observed within your code. -title: '' -labels: '' +title: '[Performance]: ' +labels: 'type: Performance' --- ### Summary of Problem + +**Description:** -**Is it a blocker for you?** - -- [ ] Yes -- [ ] No -- [ ] Will be in the future +**Is this a blocking issue with no known work-arounds?** + ### Steps to Reproduce @@ -30,21 +26,19 @@ Tick putting 'x' inside the box. // Otherwise, you can attach it as a file or provide a URL to it. // To the extent possible, providing simplified programs demonstrating the // problem will be appreciated. -// You can also replace this section with "Associated Future Test(s)" below. ``` **Compile command:** +`--fast` optimization flag enabled? + + **Execution command:** - - -**Associated Future Test(s):** - + ### Configuration Information diff --git a/.github/ISSUE_TEMPLATE/03-documentation.md b/.github/ISSUE_TEMPLATE/03-documentation.md new file mode 100644 index 000000000000..0a33ef84ddab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-documentation.md @@ -0,0 +1,50 @@ +--- +name: Documentation +about: Report any issue observed within the Chapel documentation or the `chpldoc` tool. +title: '[Documentation]: ' +labels: '' +--- + +### Summary of Problem + +**Description:** + + +### Steps to Reproduce + +**Source Code:** + +```chapel +// Please provide source code that will reproduce the problem. +// You can insert your code inline if it's not too long. +// Otherwise, you can attach it as a file or provide a URL to it. +// To the extent possible, providing simplified programs demonstrating the +// problem will be appreciated. +// You can also replace this section with "Associated Future Test(s)" below. +``` + +**Compile command:** + + +**Additional steps:** + + +**Associated Future Test(s):** + + +### Configuration Information + +- Output of `chpldoc --version`: +- Output of `$CHPL_HOME/util/printchplenv --anonymize`: +- Back-end compiler and version, e.g. `gcc --version` or `clang --version`: +- Sphinx version: +- sphinxcontrib-chapeldomain version: +- (For Cray systems only) Output of `module list`: diff --git a/.github/ISSUE_TEMPLATE/99-blank.md b/.github/ISSUE_TEMPLATE/99-blank.md new file mode 100644 index 000000000000..3a38a37ff8cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/99-blank.md @@ -0,0 +1,4 @@ +--- +name: Blank Issue +about: Don’t see your issue here? Open a blank issue. +--- diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000000..3ba13e0cec6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6a0dd38e7157..000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature Request -about: Request a feature for the project. -title: '' -labels: '' ---- - -### Description of the feature - - -**Is it a blocker for you?** - -- [ ] Yes -- [ ] No -- [ ] Will be in the future - -### Code sample From 2384d94233d912a3f346f14d85a2e2c36b0f36e6 Mon Sep 17 00:00:00 2001 From: Guillaume-Helbecque Date: Thu, 21 Mar 2024 17:21:32 +0100 Subject: [PATCH 4/5] address reviewer feedbacks Signed-off-by: Guillaume-Helbecque --- .github/ISSUE_TEMPLATE/01-feature_request.md | 2 +- .github/ISSUE_TEMPLATE/03-documentation.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-feature_request.md b/.github/ISSUE_TEMPLATE/01-feature_request.md index 016e8dcfbd2b..0a1a025b791e 100644 --- a/.github/ISSUE_TEMPLATE/01-feature_request.md +++ b/.github/ISSUE_TEMPLATE/01-feature_request.md @@ -1,6 +1,6 @@ --- name: Feature Request -about: Request for any feature you'd Chapel to support. +about: Request for anything new you'd like Chapel to support. title: '[Feature Request]: ' labels: 'type: Feature Request' --- diff --git a/.github/ISSUE_TEMPLATE/03-documentation.md b/.github/ISSUE_TEMPLATE/03-documentation.md index 0a33ef84ddab..e64ac05fd7ac 100644 --- a/.github/ISSUE_TEMPLATE/03-documentation.md +++ b/.github/ISSUE_TEMPLATE/03-documentation.md @@ -2,7 +2,7 @@ name: Documentation about: Report any issue observed within the Chapel documentation or the `chpldoc` tool. title: '[Documentation]: ' -labels: '' +labels: 'area: Docs' --- ### Summary of Problem @@ -18,8 +18,8 @@ What did you expect to observe? **Source Code:** ```chapel -// Please provide source code that will reproduce the problem. -// You can insert your code inline if it's not too long. +// Please provide source code that will reproduce the problem if it seems to be +// with chpldoc itself. You can insert your code inline if it's not too long. // Otherwise, you can attach it as a file or provide a URL to it. // To the extent possible, providing simplified programs demonstrating the // problem will be appreciated. @@ -45,6 +45,6 @@ e.g. [`test/path/to/foo.chpl`]( - Output of `chpldoc --version`: - Output of `$CHPL_HOME/util/printchplenv --anonymize`: - Back-end compiler and version, e.g. `gcc --version` or `clang --version`: -- Sphinx version: -- sphinxcontrib-chapeldomain version: +- Sphinx version, e.g. `grep -E "^Sphinx" $CHPL_HOME/third-party/chpl-venv/chpldoc-requirements2.txt`: +- sphinxcontrib-chapeldomain version, e.g. `grep -E "^sphinxcontrib-chapeldomain" $CHPL_HOME/third-party/chpl-venv/chpldoc-requirements3.txt`: - (For Cray systems only) Output of `module list`: From 9288247bb7cc56c39f42f9395016ad85b667ac20 Mon Sep 17 00:00:00 2001 From: Guillaume-Helbecque Date: Thu, 21 Mar 2024 17:41:24 +0100 Subject: [PATCH 5/5] fix typo Signed-off-by: Guillaume-Helbecque --- .github/ISSUE_TEMPLATE/01-feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/01-feature_request.md b/.github/ISSUE_TEMPLATE/01-feature_request.md index 0a1a025b791e..b7e29b28cfb1 100644 --- a/.github/ISSUE_TEMPLATE/01-feature_request.md +++ b/.github/ISSUE_TEMPLATE/01-feature_request.md @@ -20,7 +20,7 @@ Describe any work-arounds you've considered. ### Code Sample ```chapel -// Please provide source code that you'd Chapel to support. +// Please provide source code that you'd like Chapel to support. // You can insert your code inline if it's not too long. // Otherwise, you can attach it as a file or provide a URL to it. // To the extent possible, providing simplified programs demonstrating the