Skip to content

Commit

Permalink
Merge pull request #102 from keiyamamo/add_issue_temp
Browse files Browse the repository at this point in the history
add issue template
  • Loading branch information
keiyamamo authored Nov 19, 2023
2 parents da5e0de + 7109b8a commit 286fab2
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 0 deletions.
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Bug report
description: Create a report if you believe something is not working
title: "[BUG]: "
labels: ["bug"]

body:
- type: textarea
id: description
attributes:
label: How to reproduce the bug
description: Explain how to reproduce the issue you are having
placeholder: I ran a demo or test that failed. The name of the demo is `demo_something.py`
validations:
required: true

- type: textarea
id: mwe-python
attributes:
label: Minimal Example (Python)
description: Add (optionally) a minimal script that reproduces the bug
render: Python

validations:
required: false

- type: textarea
id: output-python
attributes:
label: Output (Python)
description: If you get an error message or any output, please add it here
render: bash

validations:
required: false

- type: dropdown
id: version
attributes:
label: Version
description: What version of turtleFSI are you running?
options:
- master branch
- 2.4
- 2.3
- 2.2
- 2.1
- 2.0
validations:
required: true

- type: textarea
id: output
attributes:
label: Installation
description: How did you install turtleFSI?
placeholder: i.e. "I used the Docker images on a Windows 11" or "I installed turtleFSI with conda on a MacBook Air with the M1 chip. Here are the steps to reproduce my installation ..."

- type: textarea
id: extra
attributes:
label: Additional information
description: If you have any additional information, please add it here.
placeholder: You can drag and drop files here to attach them
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Feature request
description: Add a request for a new/missing feature
labels: ["enhancement"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: textarea
id: description
attributes:
label: Describe new/missing feature
description: Explain what feature you are missing, and how you would like it to work.
placeholder: I would like to add a `subtraction` subroutine...
validations:
required: true
- type: textarea
id: code-block
attributes:
label: Suggestion user interface
description: Please create a minimal (Python) code that shows how you would like the feature to work.
render: python3
placeholder: No 3x``` encapsulation of code required

0 comments on commit 286fab2

Please sign in to comment.