Skip to content

Commit

Permalink
Update issue templates on GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
zhangt2333 committed Apr 23, 2024
1 parent 083f0cc commit 9f92137
Show file tree
Hide file tree
Showing 4 changed files with 116 additions and 30 deletions.
93 changes: 93 additions & 0 deletions .github/ISSUE_TEMPLATE/ask_question.yml
@@ -0,0 +1,93 @@
name: ❔ Ask Question
description: Ask a question about how to use something, or to understand why something isn't working as you expect it to.
labels: ["type: question"]
body:
- type: markdown
attributes:
value: |
❤️ Thank you for contributing to the using of Tai-e.
**❗ Please note:**
To expedite our response to your report and ensure it receives appropriate priority, please **include a reproducible test case** or script if possible ([see an example of how to write a reproducible case](https://github.com/pascal-lab/Tai-e/compare/how-to-write-a-reproducible-case)).
- type: textarea
id: overall-description
attributes:
label: Overall Description
description: Give a concise overview of the issue.
placeholder: "Brief overview of the issue"
validations:
required: true

- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: Describe what is actually happening.
placeholder: "What is actually happening"
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Describe what you expected to happen.
placeholder: "What you expected to happen"
validations:
required: true

- type: input
id: tai-e-version
attributes:
label: Tai-e Version
description: Specify the version or commit-hash of Tai-e you're using.
placeholder: "Tai-e version or commit-hash"
validations:
required: true

- type: textarea
id: tai-e-arguments
attributes:
label: Tai-e Arguments
description: List the arguments or settings used. Especially the analysis you are running, e.g., `-a pta=cs:ci;only-app:false -a ir-dumper`.
placeholder: |
Example:
-pp
-cp src/test/resources/pta
-a pta=cs:ci;only-app:false
-a ir-dumper
validations:
required: true

- type: input
id: jdk-version
attributes:
label: JDK Version
description: Specify the version of Java Development Kit (JDK) you are using. You can find this by running `java -version` in your terminal.
placeholder: "JDK version (e.g., Temurin 17.0.6+10)"
validations:
required: false

- type: input
id: os-info
attributes:
label: System Environment
description: Specify the operating system you are using, e.g., `Windows 10 x64`, `macOS 13.4.1 (Apple silicon)`, `Ubuntu 22.04 x64`, etc.
placeholder: Your operating system.
validations:
required: false

- type: textarea
id: additional-info
attributes:
label: Additional Information
description: Provide any additional information or context about the bug. Such as the complete analyzed program (and/or its `.tir`), the taint configuration (`taint-config.yml`), the log of Tai-e (`tai-e.log`), etc.
placeholder: |
Any other relevant information, e.g.,
the complete analyzed program (and/or its `.tir`),
the taint configuration (`taint-config.yml`),
the log of Tai-e (`tai-e.log`),
etc.
validations:
required: false
29 changes: 20 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,14 +1,15 @@
name: 🐞 Bug Report
description: Help us improve by reporting a bug
labels: []
labels: ["type: bug"]
body:
- type: markdown
attributes:
value: |
Thank you for contributing to the improvement of Tai-e.
❤️ Thank you for contributing to the improvement of Tai-e.
Every bug report is a significant contribution towards bettering our project.
**Please note:** To expedite our response to your report and ensure it receives appropriate priority, please **include a reproducible test case** or script if possible ([see an example of how to write a reproducible case](https://github.com/pascal-lab/Tai-e/compare/how-to-write-a-reproducible-case)).
**❗ Please note:**
To expedite our response to your report and ensure it receives appropriate priority, please **include a reproducible test case** or script if possible ([see an example of how to write a reproducible case](https://github.com/pascal-lab/Tai-e/compare/how-to-write-a-reproducible-case)).
- type: textarea
id: overall-description
Expand Down Expand Up @@ -50,8 +51,13 @@ body:
id: tai-e-arguments
attributes:
label: Tai-e Arguments
description: List the arguments or settings used.
placeholder: "Example: -a pta=cs:ci;"
description: List the arguments or settings used. Especially the analysis you are running, e.g., `-a pta=cs:ci;only-app:false -a ir-dumper`.
placeholder: |
Example:
-pp
-cp src/test/resources/pta
-a pta=cs:ci;only-app:false
-a ir-dumper
validations:
required: true

Expand All @@ -68,16 +74,21 @@ body:
id: os-info
attributes:
label: System Environment
description: Specify the operating system you are using.
placeholder: "e.g., Windows 10, macOS Monterey, Ubuntu 22.04"
description: Specify the operating system you are using, e.g., `Windows 10 x64`, `macOS 13.4.1 (Apple silicon)`, `Ubuntu 22.04 x64`, etc.
placeholder: Your operating system.
validations:
required: false

- type: textarea
id: additional-info
attributes:
label: Additional Information
description: Provide any additional information or context about the bug. Such as the analyzed program (or its `.tir`), the taint configuration (`taint-config.yml`), the log, etc.
placeholder: "Any other relevant information"
description: Provide any additional information or context about the bug. Such as the complete analyzed program (and/or its `.tir`), the taint configuration (`taint-config.yml`), the log of Tai-e (`tai-e.log`), etc.
placeholder: |
Any other relevant information, e.g.,
the complete analyzed program (and/or its `.tir`),
the taint configuration (`taint-config.yml`),
the log of Tai-e (`tai-e.log`),
etc.
validations:
required: false
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Expand Up @@ -5,7 +5,9 @@ body:
- type: markdown
attributes:
value: |
We appreciate your interest in enhancing Tai-e. Your suggestions play a crucial role in our project's evolution. Please provide detailed information about the feature you envision.
❤️ We appreciate your interest in enhancing Tai-e.
Your suggestions play a crucial role in our project's evolution.
Please provide detailed information about the feature you envision.
- type: textarea
id: feature-description
Expand Down
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/other.yml

This file was deleted.

0 comments on commit 9f92137

Please sign in to comment.