From 2a283c259db9d83f8cf0f7e7c40633bb0fd1003f Mon Sep 17 00:00:00 2001 From: Slava Bacherikov Date: Mon, 15 Jun 2020 19:20:28 +0300 Subject: [PATCH] Add github issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++ .github/ISSUE_TEMPLATE/new_laptop.md | 39 +++++++++++++++++++++++ 3 files changed, 85 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/new_laptop.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..d5cd3ea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a bug report +--- + +**NOTE**: *This is template for a bug report, not a request for a new unlock algorithm. If you want +to request support for new unlock algorithm use another template. + +### Please specify your environment + +* **OS**: Specify your OS +* **Browser**: specify your browser here (including version, e.g. Firefox 77, Chrome 83) +* **website domain**: does bug happens on main website ([bios-pw.org](https:///bios-pw.org/)) or + beta version ([beta.bios-pw.org](https://beta.bios-pw.org/)) +* **website version**: specify output for `https://website-domain/version-info.txt`. For example: + https://bios-pw.org/version-info.txt + +### Expected behavior + +### Actual behavior + +### Steps to reproduce the issue + +- Please be as specific as possible + +### Additional information + +Attach additional information that could help to reproduce the bug (screenshot, browser console +logs, etc). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..60078e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +--- + +**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. +For UI requests, don't hesitate to post some draws. + +**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/new_laptop.md b/.github/ISSUE_TEMPLATE/new_laptop.md new file mode 100644 index 0000000..f925bf1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_laptop.md @@ -0,0 +1,39 @@ +--- +name: Request new codes +about: Generated codes didn't worked or there was no codes at all +title: "[VENDOR]: [MODEL] [algorithm info (e.g. vendor suffix, code size)]" +labels: code +--- + +**NOTE**: *You should select this option if you are going to request support for new unlock +algorithm or existing one didn't worked for you*. + +**IMPORTANT**: before creating a new issue first check if there is any existing one with same model +or algorithm request, in that case you'd better add information to that particular issue (your +laptop model, BIOS version, screen photo, etc). + +Please replace `[VENDOR]` in a title with your laptop vendor (e.g. dell, hp, acer) and `[MODEL]` +with model, also you can specify extra information in `[algorithm info]` if you can, otherwise just +remove it from a title. + +Please specify following information: + +### General information + +* **Vendor**: specify here your laptop manufacturer (e.g. dell, hp, acer, etc.) +* **Model**: your laptop model (please be as specific as possible) +* **Firmware version**: version of your BIOS firmware, it also good if you can specify firmware + release date. + +### Photo + +It also would be helpful if you post a photo of your locked screen (with generated code, `system +disabled` message) for example like [here][photo-sample]. You can skip this if there are multiple +images with exact same message. + + +**Don't expect on immediate response**, your issue might help someone other who would face such +issue in a feature but not necessarily you. I'd suggest you to contact your vendor support, cause +this should be much faster channel. + +[photo-sample]: https://github.com/bacher09/pwgen-for-bios/issues/108#issue-638364581