From befcd3b7852161701421184816ba594ce2ce0ef3 Mon Sep 17 00:00:00 2001 From: JinGen Lim <1116555+jglim@users.noreply.github.com> Date: Fri, 8 Oct 2021 10:19:10 +0800 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 27 +++++++++++++++++++ .../feature-request---ecu-definition.md | 25 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++ 3 files changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request---ecu-definition.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..426f42b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here, e.g. ECU logs, known seed/key pairs. diff --git a/.github/ISSUE_TEMPLATE/feature-request---ecu-definition.md b/.github/ISSUE_TEMPLATE/feature-request---ecu-definition.md new file mode 100644 index 0000000..c67bf64 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request---ecu-definition.md @@ -0,0 +1,25 @@ +--- +name: 'Feature request : ECU definition' +about: Add an ECU with a known DLL/SMR-D that isn't currently in UnlockECU +title: '' +labels: '' +assignees: '' + +--- + +**ECU Name** +Name of the target, e.g. `CRD3NFZ` + +**Source file** +Name of the source file where the algorithm and definition can be reverse-engineered from, e.g. `CRD3NFZ_crd3s2_sec9A_12_34_01.dll` + +Without a known source file, the issue will be closed as it cannot be worked on. Please note that many SMR-D files do *not* include unlocking functionality. If you are referencing a SMR-D file, ensure that the file has unlocking capabilities first. + +**Additional context** +Add any other optional context about the feature request here, such as security levels, expected seed-key pairs etc. + +**Checklist** +_Please delete either YES or NO depending on the checklist question_ + +I have checked that the requested definition does not exist in [db.json](https://github.com/jglim/UnlockECU/blob/main/UnlockECU/db.json) : [YES/NO] +_Some ECUs share a common definition, for example, the CRD3 family uses the CRD3NFZ definition, and are linked together with an [alias](https://github.com/jglim/UnlockECU/blob/bcb77faa30da1babce0aca79a2d63c99618226c2/UnlockECU/db.json#L2019). If an alias is missing, please use the "Bug Report" template instead._ diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +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.