diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..181e145 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,95 @@ +name: Bug Report +description: File a bug report +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: checkboxes + id: homework + attributes: + label: Homework + options: + - label: I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md + - label: I checked the [Troubleshooting section of the README](https://github.com/nativefier/nativefier/blob/master/README.md#troubleshooting). + - label: I searched existing issues, open & closed. Yes, my bug is new. + - label: I'm using the latest version available at https://github.com/nativefier/nativefier/releases + validations: + required: false + - type: textarea + id: bug-description + attributes: + label: Bug description + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: "Give your ***full*** nativefier command and its logs, with the ***`--verbose` flag***, on a ***public*** site:" + value: | + ``` + nativefier --verbose --some-option https://mysite.com + + ``` + validations: + required: true + - type: markdown + attributes: + value: "***Tip:*** Use screenshots whenever possible to help us better diagnose the issue. For an example, see [#1175](https://github.com/nativefier/nativefier/issues/1175)" + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What you expected to happen. + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: What happened instead. + validations: + required: true + - type: textarea + id: debug-info + attributes: + label: Debug info + value: | + - 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! + validations: + required: false + - type: input + id: nativefier-version + attributes: + label: Nativefier version + description: "Output of `nativefier --version`" + - type: input + id: node-version + attributes: + label: Node.js version + description: "Output of `node --version`" + - type: input + id: npm-version + attributes: + label: npm version + description: "Output of `npm --version`" + - type: input + id: os + attributes: + label: OS + placeholder: "For example: Windows 10 build 1809" + - type: textarea + id: context + attributes: + label: Additional context + description: Any additional information that would be relevant. + placeholder: "For example: \"I'm behind a proxy, with configuration X and protocol Y\"" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index afee525..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -name: Bug report -about: Report something broken -labels: bug - ---- - - - -**Homework** - -- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md -- [ ] I checked the [Troubleshooting section of the README](https://github.com/nativefier/nativefier/blob/master/README.md#troubleshooting). -- [ ] I searched existing issues, open & closed. Yes, my bug is new. -- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases - - -**Bug description** - -A clear and concise description of what the bug is. - - -**Steps to reproduce** - -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** - -- 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: 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") diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..43b6e87 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,74 @@ +name: Feature request +description: Suggest an idea for Nativefier +labels: ["feature-request"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: checkboxes + id: homework + attributes: + label: Homework + options: + - label: I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md , no existing option fits my needs. + - label: I searched existing issues, open & closed. Yes, my feature request is new. + - label: I'm using the latest version available at https://github.com/nativefier/nativefier/releases + validations: + required: false + - type: textarea + id: problem-statement + attributes: + label: Problem statement + description: A clear and concise description of what the problem is. + value: | + For example: *Nativefier should [...]. I need it because [...]. Existing options [...] are not exactly what I want, because [...]* + + 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 + + ``` + validations: + required: true + - type: textarea + id: suggested-solution + attributes: + label: Suggested solution + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternative-solutions + attributes: + label: Alternative solutions + description: A clear and concise description of workarounds you've considered/tried. + - type: input + id: nativefier-version + attributes: + label: Nativefier version + description: "Output of `nativefier --version`" + - type: input + id: node-version + attributes: + label: Node.js version + description: "Output of `node --version`" + - type: input + id: npm-version + attributes: + label: npm version + description: "Output of `npm --version`" + - type: input + id: os + attributes: + label: OS + placeholder: "For example: Windows 10 build 1809" + - type: textarea + id: context + attributes: + label: Additional context + description: Any additional information that would be relevant. + placeholder: "For example: \"I'm behind a proxy, with configuration X and protocol Y\"" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 28dc239..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for Nativefier -labels: feature-request - ---- - - - -**Homework** - -- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md , no existing option fits my needs. -- [ ] I searched existing issues, open & closed. Yes, my feature request is new. -- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases - - -**Problem statement** - -A clear and concise description of what the problem is. For example: *Nativefier should [...]. I need it because [...]. Existing options [...] are not exactly what I want, because [...]* - -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 workarounds you've considered/tried. - - -**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) - - 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 deleted file mode 100644 index c7c77b8..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Question -about: Ask for help -labels: question - ---- - - - -**Homework** - -- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md -- [ ] I searched existing issues, open & closed. Yes, my question is new. -- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases - - -**Your question** - -Your question, expressed clearly and concisely. - - -**Steps to reproduce** - -If you already have a Nativefier command you're struggling with, paste ***full*** nativefier command and its logs, with the ***`--verbose` flag***, on a ***public*** site: - -``` -nativefier --verbose --some-option https://mysite.com - -``` - - -**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) - - Additional context: (for example: "I'm behind a proxy, with configuration X and protocol Y") diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..d1f0a2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,76 @@ +name: Question +description: Ask for help +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: checkboxes + id: homework + attributes: + label: Homework + options: + - label: I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md , no existing option fits my needs. + - label: I searched existing issues, open & closed. Yes, my question is new. + - label: I'm using the latest version available at https://github.com/nativefier/nativefier/releases + validations: + required: false + - type: textarea + id: question + attributes: + label: Your question + description: Your question, expressed clearly and concisely. + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: "If you already have a Nativefier command you're struggling with, paste ***full*** nativefier command and its logs, with the ***`--verbose` flag***, on a ***public*** site:" + value: | + ``` + nativefier --verbose --some-option https://mysite.com + + ``` + validations: + required: false + - type: textarea + id: debug-info + attributes: + label: Debug info + description: | + If applicable, + + - Console logs of your attempted `nativefier` build command, with `--verbose` flag + - Error messages + - Screenshots + - Anything else relevant! + - type: input + id: nativefier-version + attributes: + label: Nativefier version + description: "Output of `nativefier --version`" + - type: input + id: node-version + attributes: + label: Node.js version + description: "Output of `node --version`" + - type: input + id: npm-version + attributes: + label: npm version + description: "Output of `npm --version`" + - type: input + id: os + attributes: + label: OS + placeholder: "For example: Windows 10 build 1809" + - type: textarea + id: context + attributes: + label: Additional context + description: Any additional information that would be relevant. + placeholder: "For example: \"I'm behind a proxy, with configuration X and protocol Y\"" + validations: + required: false \ No newline at end of file