Skip to content

Commit

Permalink
Provide multiple github issue templates, with priority levels (chapel…
Browse files Browse the repository at this point in the history
…-lang#22935)

This PR improves the GitHub' issue templates as suggested by chapel-lang#9469 and
chapel-lang#21023. It provides five specific templates: bug report, feature
request, performance issue, documentation, and a blank issue. The
benefits of this PR are to facilitate the management of the issues by
providing the appropriate information, as well as better judge
priority/severity of an issue.

Each of these templates is written in the markdown format, and the menu
now looks as a series of buttons that allow us to choose the most
appropriate template.

Depending on the issue template used, a title prefix and/or a type label
is automatically assigned, e.g., "[Feature Request] my new feature"
assigned with the "type: Feature Request" label.

Resolves chapel-lang#9469 
Resolves chapel-lang#21023

[Contributed by @Guillaume-Helbecque, reviewed by Lydia]
  • Loading branch information
lydia-duncan authored Mar 25, 2024
2 parents 5f69ba4 + 9288247 commit 4ad2158
Show file tree
Hide file tree
Showing 6 changed files with 151 additions and 13 deletions.
33 changes: 20 additions & 13 deletions .github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/00-bug.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
<!--
If you are filing an issue that is not a bug report, please feel free to erase
this template and describe the issue as clearly as possible.
-->

---
name: Bug Report
about: Report any bug observed within your code.
title: '[Bug]: '
labels: 'type: Bug'
---

### Summary of Problem

**Description:**
<!--
What behavior did you observe when encountering this issue?
What behavior did you expect to observe?
Is this a blocking issue with no known work-arounds?
-->

**Is this a blocking issue with no known work-arounds?**
<!-- Answer 'yes', 'no' or 'I don't know'. -->

### Steps to Reproduce

Expand All @@ -29,19 +33,22 @@ Is this a blocking issue with no known work-arounds?
<!-- e.g. `chpl foo.chpl` -->

**Execution command:**
<!-- e.g. `./foo -nl 4`
If an input file is required, include it as well. -->
<!--
e.g. `./foo -nl 4`
If an input file is required, include it as well.
-->

**Associated Future Test(s):**
<!-- Are there any tests in Chapel's test system that demonstrate this issue?
e.g. [`test/path/to/foo.chpl`](
https://github.com/chapel-lang/chapel/blob/main/test/path/to/foo.chpl
) #1234 -->
<!--
Are there any tests in Chapel's test system that demonstrate this issue?
e.g. [`test/path/to/foo.chpl`](
https://github.com/chapel-lang/chapel/blob/main/test/path/to/foo.chpl
) #1234
-->

### 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`:

28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/01-feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Feature Request
about: Request for anything new you'd like Chapel to support.
title: '[Feature Request]: '
labels: 'type: Feature Request'
---

### Summary of Feature

**Description:**
<!--
Is your feature request related to an issue? Please describe.
Describe the solution you'd like.
Describe any work-arounds you've considered.
-->

**Is this a blocking issue with no known work-arounds?**
<!-- Answer 'yes', 'no' or 'I don't know'. -->

### Code Sample

```chapel
// 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
// problem will be appreciated.
```
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/02-performance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Performance Issue
about: Report any performance issue observed within your code.
title: '[Performance]: '
labels: 'type: Performance'
---

### Summary of Problem

**Description:**
<!--
What behavior did you observe when encountering this issue?
What behavior did you expect to observe?
-->

**Is this a blocking issue with no known work-arounds?**
<!-- Answer 'yes', 'no' or 'I don't know'. -->

### 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.
```

**Compile command:**
<!-- e.g. `chpl foo.chpl` -->

`--fast` optimization flag enabled?
<!-- Answer 'yes' or 'no'. -->

**Execution command:**
<!--
e.g. `./foo -nl 4`
If an input file is required, include it as well.
-->

### 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`:
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/03-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Documentation
about: Report any issue observed within the Chapel documentation or the `chpldoc` tool.
title: '[Documentation]: '
labels: 'area: Docs'
---

### Summary of Problem

**Description:**
<!--
What did you observe when encountering this issue?
What did you expect to observe?
-->

### Steps to Reproduce

**Source Code:**

```chapel
// 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.
// You can also replace this section with "Associated Future Test(s)" below.
```

**Compile command:**
<!-- e.g. `chpldoc foo.chpl` -->

**Additional steps:**
<!-- Are there any additional steps needed to demonstrate the issue beyond calling `chpldoc`? -->

**Associated Future Test(s):**
<!--
Are there any tests in Chapel's test system that demonstrate this issue?
e.g. [`test/path/to/foo.chpl`](
https://github.com/chapel-lang/chapel/blob/main/test/path/to/foo.chpl
) #1234
-->

### 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, 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`:
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/99-blank.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
name: Blank Issue
about: Don’t see your issue here? Open a blank issue.
---
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false

0 comments on commit 4ad2158

Please sign in to comment.