diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7ae8a1e..cd25f72 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,39 +1,64 @@ --- name: Bug report -about: Create a report to help us improve +about: Report something broken labels: bug --- - -**Bug description** -A clear and concise description of what the bug is. +========================================================= +INCOMPREHENSIBLE / INCOMPLETE BUG REPORTS WILL BE CLOSED. +========================================================= +--> + +**Homework** - [ ] I looked at `nativefier --help` and https://github.com/jiahaog/nativefier/blob/master/docs/api.md -- [ ] I searched existing open & closed issues. Yes, my bug is new. +- [ ] I searched existing issues, open & closed. Yes, my bug is new. - [ ] I'm using the latest version available at https://github.com/jiahaog/nativefier/releases + +**Bug description** + +A clear and concise description of what the bug is. + + **Steps to reproduce** -Give your ***full*** nativefier command, with the ***`--verbose` flag***, on a ***public*** site: -1. Run `nativefier --verbose ...` -2. ... + +Give your ***full*** nativefier command and its logs, with the ***`--verbose` flag***, on a ***public*** site: + +``` +nativefier --verbose --some-option https://mysite.com + +``` + **Expected behavior** + What you expected to happen. + **Actual behavior** + What happened instead. + **Debug info** -Verbose logs (command-line and/or in app DevTools console), error message, screenshots + +- Console logs of your `nativefier` build command, with `--verbose` flag +- If the bug happens at app run time, the in-app DevTools console logs (open it with F12) +- Error messages +- Screenshots +- Anything else relevant! + **Context** - - Nativefier: (for example: 8.0.4) - - Node.js: (for example: 13.11.0) + + - Nativefier: (for example: 9.1.0) + - Node.js: (for example: 14.6.0) - Npm: (for example: 6.14.7) - OS: (for example: Windows 10 build 1809) - Is it a regression? If yes, what's the last working / first broken version? - - Additional context: (for example: "I'm behind a proxy, with config. X and protocol Y") + - Additional context: (for example: "I'm behind a proxy, with configuration X and protocol Y") diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c6586a4..9550ab4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,30 +1,49 @@ --- name: Feature request about: Suggest an idea for Nativefier -labels: feature request +labels: feature-request --- - -**Problem statement** -A clear and concise description of what the problem is. For example: I'm always frustrated when [...] -If related to a nativefier configuration, provide the ***full*** nativefier command you ran, with the ***`--verbose` flag***, on a ***public*** site. +============================================================== +INCOMPREHENSIBLE / INCOMPLETE FEATURE REQUESTS WILL BE CLOSED. +============================================================== +--> + +**Homework** - [ ] I looked at `nativefier --help` and https://github.com/jiahaog/nativefier/blob/master/docs/api.md , no existing option fits my needs. -- [ ] I searched existing open & closed issues. Yes, my issue is new. +- [ ] I searched existing issues, open & closed. Yes, my feature request is new. + + +**Problem statement** + +A clear and concise description of what the problem is. For example: *I'm always frustrated when [...]* + +If related to a Nativefier config, provide your ***full*** nativefier command and its logs, with the ***`--verbose` flag***, on a ***public*** site: + +``` +nativefier --verbose --some-option https://mysite.com + +``` **Suggested solution** + A clear and concise description of what you want to happen. + **Alternative solutions** -A clear and concise description of alternative solutions or workarounds you've considered. + +A clear and concise description of workarounds you've considered/tried. + **Context** - - Nativefier: (for example: 7.7.1) - - Node.js: (for example: 13.10.1) + + - Nativefier: (for example: 9.1.0) + - Node.js: (for example: 14.6.0) - Npm: (for example: 6.14.7) - OS: (for example: Windows 10 build 1809) - Additional context: (for example: "I'm behind a proxy, with configuration X and protocol Y") diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..e21ea3e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,52 @@ +--- +name: Question +about: Ask for help +labels: question + +--- + + + +**Homework** + +- [ ] I looked at `nativefier --help` and https://github.com/jiahaog/nativefier/blob/master/docs/api.md +- [ ] I searched existing issues, open & closed. Yes, my question is new. +- [ ] I'm using the latest version available at https://github.com/jiahaog/nativefier/releases + + +**Your question** + +Your question, expressed clearly and concisely. + + +**Steps to reproduce** + +Give your ***full*** nativefier command, with the ***`--verbose` flag***, on a ***public*** site: +1. Run `nativefier --verbose --some-option https://mysite.com` +2. ... + + +**Debug info** + +If applicable, + +- Console logs of your attempted `nativefier` build command, with `--verbose` flag +- Error messages +- Screenshots +- Anything else relevant! + + +**Context** + + - Nativefier: (for example: 9.1.0) + - Node.js: (for example: 14.6.0) + - Npm: (for example: 6.14.7) + - OS: (for example: Windows 10 build 1809) + - Is it a regression? If yes, what's the last working / first broken version? + - Additional context: (for example: "I'm behind a proxy, with configuration X and protocol Y")