From 57fba427b2a65f834658fef0ed296e712901e202 Mon Sep 17 00:00:00 2001 From: Jan <20126033+JanLJL@users.noreply.github.com> Date: Tue, 18 Jul 2023 17:24:10 +0200 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 33 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++ .../hardware-support-request.md | 23 +++++++++++++ 3 files changed, 76 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/hardware-support-request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..847aad2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +||| +|---|---| +| OSACA version | v x.y.z | +| Used where | \[CLI / Compiler Explorer\] + +Steps to reproduce the behavior: +- OSACA command +- input code snippet or Compiler Explorer short link + +**OSACA output** +Please supply the output of the command with within a code block +``` +``` + +**Expected behavior** +A clear and concise description of what you expected to happen. + + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..9cde18a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[REQUEST]" +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/hardware-support-request.md b/.github/ISSUE_TEMPLATE/hardware-support-request.md new file mode 100644 index 0000000..6219b61 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/hardware-support-request.md @@ -0,0 +1,23 @@ +--- +name: Hardware support request +about: Request support for a new hardware architecture support +title: "[HW REQUEST]" +labels: new architecture +assignees: '' + +--- + +**Why do you need support for this specific architecture?** +Please write a short note why you need this specific architecture support. + +**Which architecture model, family and further information?** +Write a short note about the specific micro-architecture. + +**Is the documentation of the port model publicly available?** +Please refer to already existing documentation about the port model. + +**Is any documentation of the performance data of the instruction forms (throughput, latencies, port assignment, ...) publicly available?** +Please refer to already existing documentation/data bases containing information about the performance of instruction forms on this micro-arch. + +**Are there already any usable tools (commercial or open-source)?** +Please refer to already existing tools with support for this hardware micro-architecture.