From 97b569ccc56ede209ab5f754b917ddaa0f47b687 Mon Sep 17 00:00:00 2001 From: Teng Zhang Date: Sun, 19 Nov 2023 14:06:46 +0800 Subject: [PATCH] Update issue templates on GitHub --- .github/ISSUE_TEMPLATE/bug_report.yml | 77 ++++++++++++++++++---- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 47 +++++++++++-- .github/ISSUE_TEMPLATE/other.yml | 20 ++++++ 4 files changed, 125 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/other.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 4b1b53319..953bc3d65 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,32 +1,83 @@ name: 🐞 Bug Report -description: Report an issue +description: Help us improve by reporting a bug labels: [] body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + 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)). + - type: textarea - id: bug-description + id: overall-description attributes: - label: Describe the bug - description: A clear and concise description of what the bug is - placeholder: Bug description + 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: Provide the arguments you set up that caused this bug - placeholder: Tai-e arguments + label: Tai-e Arguments + description: List the arguments or settings used. + placeholder: "Example: -a pta=cs:ci;" 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. + placeholder: "e.g., Windows 10, macOS Monterey, Ubuntu 22.04" + validations: + required: false + - type: textarea - id: runtime-info + id: additional-info attributes: - label: Runtime environment infomation - description: Provide your OS, IDE, and version of Tai-e - placeholder: OS, IDE, Tai-e version + 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" validations: required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index f196ce3b5..435a743d4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,32 +1,65 @@ name: 🚀 Feature Request -description: Request a new feature +description: Suggest a new feature for Tai-e labels: ["type: enhancement"] body: - type: markdown attributes: value: | - Thanks for your interest in the project and taking the time to fill out this feature report! + 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 attributes: label: Clear and concise description of the problem - description: 'As a developer using Tai-e I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!' + description: 'As a developer using Tai-e I want [goal/wish] so that [benefit].' + placeholder: "Example: As a developer using Tai-e, I want a new logging feature so that I can easily debug my application." validations: required: true + + - type: textarea + id: impact-analysis + attributes: + label: Impact Analysis + description: Explain how this feature would benefit the project. + placeholder: "Potential impact of the feature" + validations: + required: false + - type: textarea id: suggested-solution attributes: - label: Suggested solution - description: 'In module [xy] we could provide following implementation...' + label: Suggested Solution + description: 'In module [xy] we could provide the following implementation...' + placeholder: "Your suggested solution" validations: - required: true + required: false + - type: textarea id: alternative attributes: label: Alternative description: Clear and concise description of any alternative solutions or features you've considered. + placeholder: "Any alternative solutions or features" + validations: + required: false + + - type: dropdown + id: intend-to-submit-a-pr + attributes: + label: Intention to submit PR + description: If you intend to submit a PR for this issue, tell us. + options: + - "Yes" + - "No" + default: 1 + validations: + required: true + - type: textarea id: additional-context attributes: - label: Additional context + label: Additional Context description: Any other context or screenshots about the feature request here. + placeholder: "Any additional context or screenshots" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml new file mode 100644 index 000000000..7e02a9fb3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -0,0 +1,20 @@ +name: 📖 Other +description: Open a blank issue. +labels: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this issue report! + Every issue 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)). + + - type: textarea + id: description + attributes: + label: Description + description: Add a description + placeholder: "Add your description here..." + validations: + required: true